audience-minutes
MkDocs
audience-minutes | MkDocs | |
---|---|---|
2 | 114 | |
38 | 18,293 | |
- | 0.9% | |
5.0 | 9.0 | |
7 months ago | 7 days ago | |
C++ | Python | |
MIT License | 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.
audience-minutes
- Ask HN: Tips to get started on my own server
-
Ask HN: How to build online calculator website?
Here's my personal goto:
Find some minimal CSS framework. My preference is Skeleton [0] or Bootstrap [1]. The key is just finding something minimal that works without too much fuss. Personally, I rather have a minimal framework provide 'responsiveness' so I don't have to worry about it but I also want it to get out of the way of anything I do.
Use JQuery [2]. Don't rely on CSS for animations or interactivity. In theory CSS does a lot. In practice it's a nightmare to use and to get it play well with whatever else I'm doing in the page.
Write in "bare" HTML and "vanilla" JavaScript. Don't use a static site generator and don't use a JavaScript framework.
Port in JavaScript libraries as needed. Some of the ones I tend to use are numeric.js [3], downlaod.js [4] and audience-minutes [5]. If you're doing spreadsheet things, maybe there's some JS package out there that will help.
Doing "raw" HTML/"vanilla" JavaScript makes me effectively unhirable but for limited scope side projects where I have full control and want to minimize bit-rot, this is fine.
The point is to create something that's minimal and focuses on functionality. The CSS is just there to make it not look like a Web 1.0 page but otherwise steps out of the way to focus on the actual usage of the application.
For context, here are some projects where I've used this philosophy (all open source, feel free to pilfer): Noixer [6], Resonator Voyant Tarot [7], Boston Train Track (now defunct) [8], CalebHarrington.com (an artist friend) [9], What Is This License [10], HSV Hero [11].
[0] http://getskeleton.com/
[1] https://getbootstrap.com/
[2] https://jquery.com/
[3] https://github.com/sloisel/numeric
[4] https://github.com/rndme/download
[5] https://github.com/berthubert/audience-minutes
[6] https://mechaelephant.com/noixer/
[7] https://abetusk.github.io/ResonatorVoyantTarot/
[8] https://github.com/abetusk/bostontraintrack
[9] https://calebharrington.com/
[10] https://mechaelephant.com/whatisthislicense/
[11] https://mechaelephant.com/hsvhero
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?
streamlit - Streamlit — A faster way to build and share data apps.
sphinx - The Sphinx documentation generator
bostontraintrack - Simple real time tracking of the Boston Red, Orange and Blue metro lines using Open Street Map (via OpenLayers) and the MBTA's real time metro tracking. (service is now shut down)
pdoc - API Documentation for Python Projects
numeric - Numerical analysis in Javascript
DocFX - Static site generator for .NET API documentation.
download - file downloading using client-side javascript
Hugo - The world’s fastest framework for building websites.
ResonatorVoyantTarot - An experiment in creating generative tarot cards.
Docusaurus - Easy to maintain open source documentation websites.
bulma-templates - free flexbox templates built with the bulma css framework
BookStack - A platform to create documentation/wiki content built with PHP & Laravel