Docs
Axone documentation portal (built with Docusaurus).
Overview
The AXONE documentation portal is an open-source initiative that provides a comprehensive resource for anyone interested in the AXONE protocol. Built using Docusaurus, this modern static website generator ensures an efficient and user-friendly interface for navigating through the various documentation sections. Whether you're a developer looking to contribute or simply curious about AXONE, the documentation is designed to cater to a wide audience by presenting technical details in an approachable format.
Getting started is easy—local development is supported with a live server that reflects changes in real time. There are also clear guidelines for building the documentation and maintaining code quality, ensuring that contributions meet the project's standards. The collaborative spirit is evident, inviting users to engage with the community and enhance the documentation together.
Features
- Local Development: A command starts a live server on your machine, allowing changes to be seen instantly in the browser.
- Search Functionality: Though the search feature isn't available during development, users can generate a build to fully utilize it.
- Static Content Generation: The build command creates static content ready to be hosted, ensuring quick page loads and seamless user experience.
- Code Quality Tools: Commitlint, Markdownlint, Prettier, and Stylelint are integrated to maintain high standards in coding style and documentation consistency.
- Open Source License: The project follows a 3-Clause BSD license, encouraging contributions while protecting user rights.
- Community Engagement: The project fosters a collaborative community where users can share knowledge, ask questions, and discuss experiences related to AXONE.
- Contribution Guidelines: Clear instructions and a code of conduct are provided for users interested in contributing to the project.
- 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.
- 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.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.