www.mechaelephant.com
MkDocs
www.mechaelephant.com | MkDocs | |
---|---|---|
3 | 114 | |
1 | 18,293 | |
- | 0.9% | |
8.8 | 9.0 | |
19 days ago | 8 days ago | |
JavaScript | Python | |
- | BSD 2-clause "Simplified" 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.
www.mechaelephant.com
- Ask HN: Tips to get started on my own server
- A search engine in 80 lines of Python
-
My Second Brain – Zettelkasten
For me, the idea is sound but the implementation always seems so cumbersome. I want something that separates the data from the display as much as possible, has an easy 'note taking' and has an easy install. One problem I always encounter is that if the interface to add notes has too much friction, I stop using it pretty quickly.
Anyway, so I created something over the weekend called 'notenox' [0]. It creates a a JSON file of relevant information, one JSON file per note, with keywords and a "special" keyword prefix called a 'title' that mimics how I've actually been taking notes (email, so the 'title' mimics an email thread). For display, I consolidate all JSON files into a single JSON file and then have it loaded into the browser with some Javascript to group by title or keyword, along with doing all cross referencing and counting on the client end.
Creating notes is done through the command line, because that's a common way I interact with my computer, with different options to create titles, links, keywords, etc. I'm sure there are many different Zettelkasten implementations out there but they always seem so clunky and cumbersome. It's not hard, so the simple use case should be simple, nor should it proprietary or locked behind a SaaS.
You can see my personal notes in action, if you like [1] (sorry, not mobile friendly!).
[0] https://github.com/abetusk/www.mechaelephant.com/tree/releas...
[1] https://mechaelephant.com/notenox
MkDocs
- I am stepping down from MkDocs
-
Alternatives to Docusaurus for product documentation
MkDocs is BSD-2-Clause licensed and has a vibrant community; GitHub Discussion is used for questions and high-level discussion, while the Gitter/Matrix chat room is used to discuss less complex topics. These communities provide essential resources and support.
- Ask HN: Tips to get started on my own server
-
Enhance Your Project Quality with These Top Python Libraries
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
-
Top 5 Open-Source Documentation Development Platforms of 2024
MkDocs is a popular static site generator designed explicitly for building project documentation. Its minimalist approach, flexibility, and ease of use have made it a favorite among developers and ideal for non-technical users.
-
5 Best Static Site Generators in Python
MkDocs is a popular static site generator specifically designed for project documentation. It is built on Python's Markdown processing engine and comes with a clean and responsive default theme. MkDocs is easy to configure, and its simplicity makes it an excellent choice for quickly creating documentation for your projects.
-
Creating a knowledge base website for work, do I need a database or can it be only front end designed?
Take a look at https://www.mkdocs.org
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Examples with Github Pages?
I was thinking about using MkDocs, its usually used for documentation but I don't see why it couldn't be used for a normal wiki aswell. Since It's markdown you can just customize it like if it were a wiki, and a wiki doesn't really need backend stuff so I don't see a problem with it
What are some alternatives?
anystyle - Fast citation reference parsing
sphinx - The Sphinx documentation generator
pdoc - API Documentation for Python Projects
DocFX - Static site generator for .NET API documentation.
Hugo - The world’s fastest framework for building websites.
Docusaurus - Easy to maintain open source documentation websites.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Read the Docs - The source code that powers readthedocs.org
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
VuePress - 📝 Minimalistic Vue-powered static site generator
mkdocs-material - Documentation that simply works