awesome-readme-template
mkdocs-material
Our great sponsors
awesome-readme-template | mkdocs-material | |
---|---|---|
7 | 93 | |
1,665 | 18,269 | |
- | - | |
0.0 | 9.8 | |
about 2 years ago | 2 days ago | |
HTML | ||
Creative Commons Zero v1.0 Universal | 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.
awesome-readme-template
-
What's considered non-trivial?
I think it's much more important to start small with portfolio projects, and 100% add a readme to your github or no one will ever look at it. Even a small project can be a non-trivial amount of work if it's polished to a high standard.
- Next Level Readme Template
- Next Level Readme
- Next Level Github Readme
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.
What are some alternatives?
Best-README-Template - An awesome README template to jumpstart your projects!
Docusaurus - Easy to maintain open source documentation websites.
The-Documentation-Compendium - 📢 Various README templates & tips on writing high-quality documentation that people want to read.
sphinx - The Sphinx documentation generator
readme-template - A Readme Template For Tomorrow's Opensource
MkDocs - Project documentation with Markdown.
readme-template - :file_cabinet: modelo de readme.md que utilizo nos repositórios dos meus projetos
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
awesome - 😎 Awesome lists about all kinds of interesting topics
Read the Docs - The source code that powers readthedocs.org
mike - Manage multiple versions of your MkDocs-powered documentation via Git
BookStack - A platform to create documentation/wiki content built with PHP & Laravel