slate
Docusaurus
Our great sponsors
slate | Docusaurus | |
---|---|---|
21 | 280 | |
35,788 | 52,283 | |
0.3% | 2.4% | |
4.4 | 9.5 | |
10 days ago | about 11 hours ago | |
SCSS | TypeScript | |
Apache License 2.0 | 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.
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 )
-
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.
-
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
-
What would you like to see Stripe improve on iOS?
I'm using Slate right now which is a common recommendation for Stripe-like documentation, but obviously it's not the same.
-
Favorite API Documentation UI/UX
While not as visually impressive with flashy graphics and UI elements, Twilio's documentation has similar Stripe vibes as I believe it's built on Slate which is about as close to Stripe's framework as you can get. I like the theme used[4] in the code sample section as it's a nice break from the standard colors and it's easy on the eyes.
-
Best toolset/workflow for prototyping and iterating an API?
That's about the API design and specification. Now let's turn our attention to API UIs for visualisation and interaction. API UIs are useful for other people to easily understand your API. Again, quite a variety of choices in this area, but the most common are Swagger UI and Redoc. Lots of frameworks and tools will allow you to render the Swagger or Redoc UI of an OpenAPI spec from the specification document, such as Swagger's editor. And if you're comfortable enough with JavaScript, you can do the rendering yourself using the npm package. A fancier UI is Slate. I don't know whether Slate will automatically generate code samples in every popular language, but it does allow you to write the samples yourself. There're various tools that render a Slate UI from an OpenAPI specification. I believe Postman also allows you to generate a fancy UI.
-
Best platform for writing api docs?
For API-specific docs I use Slate as I like the code sample section off to the right. I converted our previous severely lacking Swagger setup to a full-featured framework with Slate that has significantly reduced the number of support emails regarding API questions.
Docusaurus
-
Show HN: A Python-based static site generator using Jinja templates
Facebook's React/Markdown SSG docusaurus does those things: https://docusaurus.io/
Though you may have to use a plugin for responsive images: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-id...
- Craft Your GitHub Profile Page in 60 Seconds with Zero Code, Absolutely Free
-
Top 5 Open-Source Documentation Development Platforms of 2024
Docusaurus is an open-source static site generator built on React and has emerged as a popular tool for developing and maintaining product documentation. Its ease of use, extensive features, and robust community support make it a compelling choice for many organizations.
-
No CMS? Writing Our Blog in React
Wondering why Docusaurus (https://docusaurus.io) did not match their needs. Works perfectly fine as a blogging engine for our tech blog.
-
Best Software Documentation Tools
This is developed by Meta. You can create really nice-looking documentation websites super fast.
-
Can Git or any other VCS be used as a database instead of SQL/NoSQL ones? Have you ever seen such a thing?
Docusaurus, a documentation tool by Facebook, hosts a showcase of other websites that use Docusaurus on their Homepage. The list of websites of this showcase is a typescript files that is maintained by Docusaurus devs, and that you can add your website to through PR: https://github.com/facebook/docusaurus/blob/main/website/src/data/users.tsx
-
Community project: PreventRansomware.io
Fix "Edit this page" links at the bottom of each doc (Problem with the Docusaurus build I guess)
-
Ask HN: What are some unpopular technologies you wish people knew more about?
How about docusaurus and tinasaurus? The latter is based on TinaCMS.
[1] Docusaurus:
[2] Tinasaurus:
-
How To De-index Your Docs From Google (And Then Fix It)
The large differences in approaches and product features led us to rebuild the documentation for Camunda 8. C7 docs are hosted at docs.camunda.org; the version 8 documentation lives at docs.camunda.io. The two different sites are built with different tooling (Hugo vs Docusaurus).
-
Code Reading Docusaurus
Fist, I got into Docusaurus Repo and searched codes that I was looking for, my keyword was codeblocks and there were some files involved with codeblocks. I could find the test file as well.
What are some alternatives?
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
oauth2-proxy - A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
JSDoc - An API documentation generator for JavaScript.
VuePress - 📝 Minimalistic Vue-powered static site generator
MkDocs - Project documentation with Markdown.
mkdocs-material - Documentation that simply works
docsify - 🃏 A magical documentation site generator.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Hugo - The world’s fastest framework for building websites.