mdBook
stefan.midjich.name | mdBook | |
---|---|---|
2 | 101 | |
- | 16,754 | |
- | 1.5% | |
- | 8.6 | |
- | 5 days ago | |
Rust | ||
- | Mozilla Public License 2.0 |
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.
stefan.midjich.name
-
Greetings, right now I use Google cloud to host one of my websites. I pay around $18 a month for just one website.
You can also see an example of a deployment pipeline here, which is used to deploy my personal website.
-
Markdown based wiki I can git push to?
I can add another example because I use this method to push mkdocs for my personal website and it's all on gitlab here.
mdBook
- Everything Curl
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
What are some alternatives?
wiki - The official Wiki of the selfhosted.show Podcast.
gitbook - The open source frontend for GitBook doc sites
doc-store-template - This is a template repo to make a document store in git
MkDocs - Project documentation with Markdown.
Gitea - Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
Grav - Modern, Crazy Fast, Ridiculously Easy and Amazingly Powerful Flat-File CMS powered by PHP, Markdown, Twig, and Symfony
bookdown - Authoring Books and Technical Documents with R Markdown
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
retype - Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files.
Docusaurus - Easy to maintain open source documentation websites.