Substrate Docs
Substrate Developer Hub. Substrate is powered by best in class cryptographic research and comes with peer to peer networking, consensus mechanisms, and much more.
Overview:
The documentation for Substrate provides guidelines for contributing to the project, including submitting issues, making pull requests, and proposing new content. The document outlines how to structure URL paths, manage media and images, and configure navigation. Instructions for local development, troubleshooting, and security are also provided.
Features:
- Contribution Guidelines: Guidelines for community members to contribute to Substrate documentation.
- URL Paths: Defines how URL paths are structured for .md files added to the /docs folder.
- Media Management: Instructions on storing and referencing images in the documentation.
- Navigation Configuration: Details on updating the navigation configuration for the documentation.
- Local Development Setup: Steps for installing dependencies and setting up the local development environment.
- Troubleshooting Tips: Guidelines for handling issues related to Gatsby's cache during development.
- Security Reporting: Instructions for reporting security bugs in the repository.
- License Information: Information on the usage of documentation outside the official host.
- Gatsby
GatsbyJS is a free and open-source static site generator based on React. It uses a modern development stack including Webpack, GraphQL, and modern JavaScript and CSS frameworks. It also provides a rich set of plugins, starters, and themes.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Postcss
PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.
- Prism JS
PrismJS is an open-source, lightweight, and extensible syntax highlighting library that supports a wide range of programming languages and markup formats.
