slate
Hugo
Our great sponsors
slate | Hugo | |
---|---|---|
21 | 548 | |
35,827 | 72,452 | |
0.3% | 1.4% | |
4.4 | 9.8 | |
6 days ago | 4 days ago | |
SCSS | Go | |
Apache License 2.0 | Apache 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.
slate
-
10+ API Documentation Tools For Super Busy Developers 👩💻
Slate (Free)
-
How do i document my api ?
https://github.com/slatedocs/slate this ! Big company use it ( stripe etc )
- This is not strictly coding related but it could be. I want to implement something and want to know how to.
-
[ARTICLE] Stripe Releases Their Documentation Framework
The second most common question being "What framework does Stripe use to build their documentation?" and the answer has unfortunately always been "They use a custom setup they built themselves and isn't available." - so then Slate gets brought up as a suitable replacement
-
Twelve Amazing Free Hugo Documentation Themes
DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.
-
Best way to document Express API
I've used Slate to document APIs which similarly will produce a local website. You can host that privately or there's built in support to push to github pages if you're hosting it in a github repo. The documentation itself is all written in markdown and managed separate from your API code.
-
What does stripe use to make their docs?
Clone/inspired by stripe docs: https://github.com/slatedocs/slate
-
Create and deploy API documentation to Kubernetes
If you are going to use Slate from the console you need to install it, along with all its prerequisites, as described here. In Ubuntu you can execute the commands:
-
How does Stripe create this style of documentation?
Slate - API Generator
- Building API Docs
Hugo
-
Creating excerpts in Astro
This blog is running on Hugo. It had previously been running on Jekyll. Both these SSGs ship with the ability to create excerpts from your markdown content in 1 line or thereabouts.
-
Craft Your GitHub Profile Page in 60 Seconds with Zero Code, Absolutely Free
Hugo
- Release v0.123.0 · Gohugoio/Hugo
-
Top 5 Open-Source Documentation Development Platforms of 2024
Hugo is a popular static site generator specifically designed to create websites and documentation lightning-fast. Its minimalist approach, emphasis on speed, and ease of use have made it popular among developers, technical writers, and anybody looking to construct high-quality websites without the complexity of typical CMS platforms.
-
Ask HN: Looking for lightweight personal blogging platform
As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.
-
Get People Interested in Contributing to Your Open Project
Create the technical documentation of your project You can use any of the following options: * A wiki, like the ArchWiki that uses MediaWiki * Read the Docs, used by projects like Setuptools. Check Awesome Read the Docs for more examples. * Create a website * Create a blog, like the documentation of Blowfish, a theme for Hugo.
-
Writing a SSG in Go
Doing this made me appreciate existing SSGs like Hugo and Next.js even more👏👏
- Hugo 0.122 supports LaTeX or TeX typesetting syntax directly from Markdown
-
Why Blogging Platforms Suck
I suggest hugo: https://gohugo.io/
Generates a completely static website from MD (and other formats) files; also handles themes (including a lot of them rendering well on mobile), and different types of content - posts, articles, etc. - depending on the theme.
It's open source and, being completely static, cheap as fuck to self host.
-
Any FOSS to make HTML websites for self-hosting?
I would suggest looking into static site generators. Some popular examples, which are used myself are: - Hugo: https://gohugo.io/ - Jekyll: https://jekyllrb.com
What are some alternatives?
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
MkDocs - Project documentation with Markdown.
django-rest-framework - Web APIs for Django. 🎸
Pelican - Static site generator that supports Markdown and reST syntax. Powered by Python.
docusaurus-openapi - 🦕 OpenAPI plugin for generating API reference docs in Docusaurus v2.
eleventy 🕚⚡️ - A simpler site generator. Transforms a directory of templates (of varying types) into HTML.
Docusaurus - Easy to maintain open source documentation websites.
Hexo - A fast, simple & powerful blog framework, powered by Node.js.
mkdocs
obsidian-export - Rust library and CLI to export an Obsidian vault to regular Markdown