A powerful documentation framework on top of MkDocs

Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices.

MKdocs

note

Deploy

Deploy With Vercel(Recommended)

Just click the button above and follow the instructions to deploy your own copy of the app.

Deploy With Docker

• https://hub.docker.com/r/miniwater/mkdocs
• https://github.com/miniwater/mkdocs/pkgs/container/mkdocs

To deploy with Docker, you can use the following command:

docker run -d --name mkdocs -p 80:8000 miniwater/mkdocs:latest

or

docker run -d --name mkdocs \
--restart always \
-p 80:8000 \
miniwater/mkdocs:latest

This will start the geminiprochat service, accessible at http://localhost:80.

Contributing

Contributions of all types are more than welcome; if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] and [Projects][github-project-link] to get stuck in to show us what you’re made of.

Star History

FOSSA Status

License

MIT License

Copyright (c) 2014-2023 手里有只毛毛虫, All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.