mkdocs-material
api-scripts
mkdocs-material | api-scripts | |
---|---|---|
93 | 26 | |
18,269 | 80 | |
- | - | |
9.8 | 5.1 | |
7 days ago | 6 days ago | |
HTML | JavaScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mkdocs-material
-
🚚 Building MVPs You Won’t Hate
Material Mk-Docs by Martin Donath works well if you prefer python.
-
The Open Source Sustainability Crisis
https://squidfunk.github.io/mkdocs-material/
I'm an 'outsider', but from from the outside the Material For MkDocs Project looks like a very well managed open source project.
Martin Donath's project uses a 'sponsorware' release strategy to generate donations.
From my vantage point it seems to be working pretty well.
- Release Mkdocs-Material-9.5.0
- Agora a nossa Megathread possui um novo visual!
-
Ask HN: What's the best place to start a newsletter?
I just recently went through this decision process. My aim is to write code and math oriented posts so I need good support for nice syntax highlighting (at least colored) and mathjax (preferable) or katex. Substack is the most popular newsletter platform but fails at these two criteria. I love how math and syntax highlighting (plus numerous other features) work in MkDocs Material, which recently added a Blog plugin.
I wanted to combine the best of both: Substack as an amazing email social network, and MkDocs Material’s awesome look. So I’ve gone with using Substack as the core platform which I use to manage subscribers, and use it to post either math/code-free posts or a short teasers pointing to my main blog site on MkDocs Material when I need to show math/code
https://squidfunk.github.io/mkdocs-material/
- Material for MkDocs – Documentation that simply works
- Features tied to 'Piri Piri' funding goal
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Changing CMS from Wordpress to ?
I've been migrating content to MKDocs (Material) over the last few months, so feel fairly qualified on this subject. It's somewhat limited in terms of navigation, but can probably handle 400-500 pages; you can see how navigation works in the link. Otherwise, it can handle most, if not all, the tasks you've listed.
- Kann man von Open Source leben? Interview mit Martin Donath, der von Open Source lebt.
api-scripts
- Question on importing from MD files?
-
Migrate from MediaWiki
Not really specific tools for that purpose, but our api-scripts repo has a collection of examples that use the API, which could be used as a basis for building something more specific. Within the readme there is also a variety of more extensive community project, some of which may also be useful here.
-
Download offline version of bookstack site
You could run a script that uses the API to export all content to PDF/HTML. I have a basic example of this here in our API scripts repo.
-
Would like to create documentation for my server - What are the best tools ?
Their Script
- New API Script Example in PowerShell: Create BookStack Pages from HTML Files
-
Homelab Documentation
To add to this, some people script and cron regular exports via the API. I have a basic example script here.
-
How to import markdown via CLI?
Also, if it helps, we have API script examples here and there is an existing bash cli build here.
-
Move to BookStack from WikiJS?
If you wanted accessible non-DB copies of your content, this is possible via a couple of options. Some users script exports of all their books. I have an example of this here in our API script examples repo. Alternatively you could write out raw content to plain files on the system via hooking into events using our logical theme system. I have an basic example of doing this for HTML format content within this blog post.
-
I'm being overwhelmed by text files cataloguing what I've done on various servers
I found this this evening
-
Any self-hosted alternative to Confluence for wikis that comes anywhere close?
Can't give too much advice in regards to Confluence, but in regards to BookStack import the REST API is probably the best best. API docs can be seen on our demo instance here. API usage examples, and community projects/scripts, can be found here if it helps. You might be able to find existing confluence to bookstack scripts. Came across this in a search but not sure how feature complete or up-to-date it is.
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
sphinx - The Sphinx documentation generator
Dokuwiki - The DokuWiki Open Source Wiki Engine
MkDocs - Project documentation with Markdown.
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
L5-Swagger - OpenApi or Swagger integration to Laravel
Read the Docs - The source code that powers readthedocs.org
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
mike - Manage multiple versions of your MkDocs-powered documentation via Git
bs