https://github.com/leadcodedev/bubble_doc
The Bubble project is a tool for generating documentation from markdown files, designed to be simple and effective thanks to the Dart language.
https://github.com/leadcodedev/bubble_doc
Last synced: 4 months ago
JSON representation
The Bubble project is a tool for generating documentation from markdown files, designed to be simple and effective thanks to the Dart language.
- Host: GitHub
- URL: https://github.com/leadcodedev/bubble_doc
- Owner: LeadcodeDev
- Created: 2024-06-08T19:52:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-09T07:44:21.000Z (almost 2 years ago)
- Last Synced: 2025-03-06T00:36:06.192Z (about 1 year ago)
- Language: Dart
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bubble Documentation
## Motivation
There are a multitude of tools for designing documentation, such
as [Undocs](https://undocs.pages.dev), [VitePress](https://vitepress.dev), [Docusaurus](https://docusaurus.io)
and [Docs-boilerplate](https://github.com/dimerapp/docs-boilerplate) used for all Adonis packages.
The problem, with the exception of the Adonis boilerplate, is that they all use a frontend framework/library which, in
my opinion, is not necessary for the design of documentation.
When we talk about documentation and thus a "content first" approach, we think directly of
the [Astro framework](https://astro.build/) which promises relatively efficient generation of static documents from
markdown files; however, this tool is not designed to be used fully for project documentation.
This is why I decided to create Bubble, a tool for generating documentation from markdown files without the need to use
a frontend framework.
### Choice of technologies
As a big fan of the Dart language, I decided to create Bubble using the Dart language in order to take advantage of its
content generation speed during the build phase.
> [!NOTE]
> Bubble can generate more pages than Astro 👀
## Installation
Installing Bubble is very simple, just use this repository as
the [template](https://github.com/new?template_name=bubble_doc&template_owner=LeadcodeDev) for your project.
Once done, simply run the following command to install the dependencies:
```bash
dart pub get
```
## Roadmap
- [ ] Include sitemap.xml
- [ ] Enhance documentation ui
- [ ] Add algolia search engine
- [ ] Add dark mode
- [ ] Simplify the configuration file (via yaml)
- [ ] Add all metadata to the markdown files
- [ ] Target layout file from the markdown file
- [ ] Add a search engine
## Benchmark
Bubble is a very fast tool for generating documentation, here is a comparison with other tools:
- Mac Studio M2
- Template documentation with one collection and one marddkwn page
| Iteration | Astro | Bubble |
|-----------|--------|---------|
| 10 | 490ms | 21ms |
| 100 | 720ms | 276ms |
| 1000 | 2690ms | 2462ms |
| 10000 | ? | 25338ms |