https://github.com/devpaulorcc/manualist
👨🏫 Customizable software documentation using markdown files.
https://github.com/devpaulorcc/manualist
documentation markdown vuejs
Last synced: about 1 year ago
JSON representation
👨🏫 Customizable software documentation using markdown files.
- Host: GitHub
- URL: https://github.com/devpaulorcc/manualist
- Owner: devpaulorcc
- Created: 2025-02-02T16:35:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-02T17:30:04.000Z (over 1 year ago)
- Last Synced: 2025-03-26T22:51:17.866Z (about 1 year ago)
- Topics: documentation, markdown, vuejs
- Language: Vue
- Homepage: https://manualist.vercel.app
- Size: 188 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Manualist is the popular way to create simple documentation
> Manualist is an intuitive and easy-to-use tool. Just create a fork to start documenting your software in a simple way, adding Markdown files to the "public/docs" directory. These files are automatically loaded into a visual interface, allowing fluid navigation between pages. Additionally, you can use HTML to create links from "docs/" and thus the name of the markdown file, having a dynamic route, customize the documentation style and much more.
---
**Use Manualist** to document your projects in a simple way 🚀
- **Easy customization**: Although the project uses Vue.js, in-depth knowledge is not required to customize its documentation.
- **Dynamic routes**: Routes to your markdown files will be defined from "docs" and then the name of the markdown file, for example "docs/introdution", the file named "introdution.md" will be loaded.
Use Manualist as a base for two documentation, change colors, fonts and other styles.
## Contribution
We welcome contributions from the community! Whether you want to fix a bug, add a new feature, or improve the documentation, your help is appreciated. To contribute to the project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your changes.
3. Make your modifications.
4. Commit your changes and push them to your fork.
5. Submit a pull request to the main repository.
> ✏️ **Note**: Write a clear description of your changes in the pull request to help us understand the modifications.