https://github.com/robinruf/shiori
A modern and fast to setup Documentation Framework for NextJS 14+
https://github.com/robinruf/shiori
documentation documentation-framework markdown mdx nextjs react shiori static-site-generator
Last synced: over 1 year ago
JSON representation
A modern and fast to setup Documentation Framework for NextJS 14+
- Host: GitHub
- URL: https://github.com/robinruf/shiori
- Owner: RobinRuf
- License: mit
- Created: 2025-02-13T06:12:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-23T14:22:44.000Z (over 1 year ago)
- Last Synced: 2025-02-23T15:26:03.218Z (over 1 year ago)
- Topics: documentation, documentation-framework, markdown, mdx, nextjs, react, shiori, static-site-generator
- Language: TypeScript
- Homepage: https://shiori.page
- Size: 203 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Shiori (栞)
A simple, modern and fast to setup Documentation Framework for Next.js 14+.
## Documentation
[https://shiori.page](https://shiori.page)
## Turbopack
> [!NOTE]
> Shiori does not work in combination with **Turbopack** yet.\
> So it will only work in Project without Turbopack enabled.
## Contributing
Unlike most others, this documentation framework is minimalist. Piece by piece, additional MDX components are created to make the resulting documentation even more beautiful. However, the goal is to keep this package as simple and clean as possible. This is one of the reasons why I decided against a monorepo/turborepo, as I felt this would be superfluous, especially for the beginning.
I think that everyone should be able to create a visually appealing and well-structured documentation for their SaaS, their open source project or their own package as easily as possible.
But first and foremost, I created Shiori because I needed it.
The existing solutions either didn't satisfy me in various ways or were completely overwhelming for me just to be able to create a small documentation.
So if you have time, desire and ideas that you think would be good for this package, feel free to contribute. 😊
Please follow the [Contribution Guide](https://github.com/RobinRuf/shiori/blob/main/CONTRIBUTING.md)
## TODO
coming soon...