retype
mkdocs-material
Our great sponsors
retype | mkdocs-material | |
---|---|---|
20 | 92 | |
947 | 17,838 | |
3.0% | - | |
9.0 | 9.8 | |
2 months ago | 7 days ago | |
JavaScript | HTML | |
GNU General Public License v3.0 or later | 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.
retype
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
How to turn a folder of markdown docs into a structured docs section in an app?
Outside of Swift, I use RetypeApp and they have a lot of inbuilt functionality. You can then generate your output directory on build, and use those HTML files as is.
-
Pushing for quality UX as an influence role
You can build pretty beautiful docs with: - https://retype.com - https://docusaurus.io - https://www.intercom.com/articles
-
GitLab Wiki or Other self-hosted wiki for Documentation
Retype is the nicest one I’ve come across in my search! Has a built in table of contents, pretty easy to create (entirely using markdown) and great support for emojis, math, containers, multi tab info panels, and proper dropdown panels.
- Where/ how you store and distribute documentation?
-
Is there an easy to use selfhosted wiki?
I recently set up something with https://retype.com/ and it's quite good.
-
Retype: A self-hosted and free alternative to gitbook
BookStack looks interesting, but certainly one massive advantage Retype has is just installation. I can have Retype installed, my website built, and running in a browser in a 10 seconds.
With Retype, your content source are simple Markdown `.md` text files. BookStack stores your data in a database, and in order to host a website you need a PHP webserver, Maria DB, etc.
A Retype generated website can be hosted for free using GitHub Pages. The retype.com website is hosted on GitHub Pages, see https://github.com/retypeapp/retype.
Hope this helps.
One will want to be aware of the licensing for this: https://github.com/retypeapp/retype/blob/v2.2.0/LICENSE.md
"Free" as in beer, it seems
Retype builds directly off Markdown files, which you can store anywhere, including GitHub. The retype.com website is built directly from a GitHub repo, see https://github.com/retypeapp/retype
The retype.com website is also hosted on GitHub Pages. Any change that is committed to the GitHub repo will trigger the website to be rebuilt by Retype using GitHub Actions, see https://retype.com/hosting/github-pages/.
Hope this helps clarify that Retype is even more tightly integrated with GitHub, or any other source management system. You have complete control and ownership of your source content files.
While gitbook does wrap the branching/merging process in a UI that is digestible by non-developers, Retype is far more powerful because you actually use GitHub (or GitLab). You have the full power of GitHub, including branching, pull-requests, issues, reviews, automation, authentication, and everything else.
For example, here's the repo for the retype.com website, see https://github.com/retypeapp/retype
The entire website is built from simple Markdown text files.
mkdocs-material
-
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.
- Agora a nossa Megathread possui um novo visual!
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Wow, what is up with the material mkdocs theme (https://squidfunk.github.io/mkdocs-material/)? That's an extremely spiffy landing page, especially given that it's for a theme designed for a totally separate piece of software.
- Koji projekat na Githubu vas je odusevio u zadnje vreme?
-
MkDocs Publisher as an alternative for official Obsidian publish.
I was considering Pelican at some stage, but MkDocs has a great mobile friendly theme (Material for MkDocs) that is part of the dependencies. This theme and my previous experience in using MkDocs, gave me a clear answer what to use. There were also some other MkDocs plugins, that I was considering to use before I started to develop my bundle, but they were lacking in some elements (like plugin for wikilinks not working correctly for Obsidian links and one for callouts with small problems in embedded callouts, etc.). Finally, I didn't use those plugins, but they were good source to take a look at the code and get some inspiration, etc. (most of those plugins will mentioned in documentation in credits section, that is under construction). If you will ever have some features requests, just create an issue in git repo of the project. I'm open to suggestions how to extend functionality ot this project.
-
Site-wide Protest, Introducing leagueoflinux.org, and Poll for What to do Next with r/leagueoflinux
The site is built using MkDocs and themed with MkDocs-Material. Being markdown-based, porting over the webpages from the subreddit wiki was fairly painless, and on some pages I've already been able to extend their capabilities with in-line images, buttons and more modern special formatting tools.
-
Anyone know of a free dev docs like confluence?
Maybe something like https://squidfunk.github.io/mkdocs-material/ or https://www.bookstackapp.com/ ?
-
Public API documentation. What to use?
I use a combo of swagger and mkdocks: https://squidfunk.github.io/mkdocs-material/
-
Ask HN: What is the best product documentation you’ve ever seen?
Visual Studio App Center has excellent documentation: https://learn.microsoft.com/en-us/appcenter/distribution/cod.... It's comprehensive and well structured.
If you're looking for a system that looks as good, mkdocs (https://www.mkdocs.org/) with the mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/) can get you quite close!
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
MkDocs - Project documentation with Markdown.
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
Read the Docs - The source code that powers readthedocs.org
mike - Manage multiple versions of your MkDocs-powered documentation via Git
furo - A clean customizable documentation theme for Sphinx
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
river-runner - Uses USGS/MERIT Basin data to visualize the path of a rain droplet to its endpoint.
typedoc - Documentation generator for TypeScript projects.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
VuePress - 📝 Minimalistic Vue-powered static site generator