Emlid Docs
Documentation for Emlid products
Overview
Emlid's documentation repository offers a comprehensive solution for managing and creating documentation using the mkdocs framework. With a structured approach to template editing and building, it simplifies the process of generating markdown and HTML documentation for developers and teams. This system is particularly beneficial for those who prefer to work with templates, ensuring a consistent and efficient documentation process.
The integration of Pipenv for dependency management further enhances the ease of use, allowing users to manage their Python packages with minimal effort. With clear guidelines on adding new templates and regenerating documentation, Emlid provides an intuitive platform that caters to both new and experienced users in the documentation space.
Features
- Template Creation: Easily create new templates in the designated directory with a .mdx extension, allowing for customized documentation style and layout.
- Configuration Simplified: Updating configuration files in YAML format enables straightforward integration of new templates within the documentation workflow.
- Rebuilding Docs: A dedicated template building script allows users to regenerate documentation seamlessly after making changes.
- Local Preview: Users can run a local server to preview the documentation, ensuring immediate visibility of their changes before deployment.
- Automated HTML Generation: The system automates the conversion of markdown files to HTML, streamlining the publishing process.
- Combined Commands: A single command line execution can build and serve the documentation simultaneously, saving time and improving productivity.
- Dependency Management: Utilizing Pipenv ensures that all necessary dependencies for the mkdocs environment are easily managed and maintained.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- 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.
