User Guides in Code Documentation: Empowering Users with Usage Instructions

• sphinx

  31 6,032 9.8 Python

  The Sphinx documentation generator

  

Sphinx a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. That is, if you have a directory containing a bunch of reStructuredText or Markdown documents, Sphinx can generate a series of HTML files, a PDF file (via LaTeX), man pages and much more.

• gitbook

  46 26,337 9.7 TypeScript

  The open source frontend for GitBook doc sites

  

GitBook is a collaborative documentation tool that allows anyone to document anything—such as products and APIs—and share knowledge through a user-friendly online platform.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• obs-studio

  2,361 55,593 9.8 C

  OBS Studio - Free and open source software for live streaming and screen recording

  

OBS Studio allows users to record their desktop screen, specific windows, or selected areas for creating video tutorials, walkthroughs, timelapses and other types of recordings. Users can select the portion of the screen they want to record through a selection tool or by specifying coordinates. They can choose to record the entire screen, a single window, or a custom region.

• Jekyll

  253 48,287 8.7 Ruby

  :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby

  

Jekyll is a static site generator. It takes text written in your favorite markup language and uses layouts to create a static website. You can tweak the site’s look and feel, URLs, the data displayed on the page, and more.

• flameshot

  232 23,168 7.8 C++

  Powerful yet simple to use screenshot software :desktop_computer: :camera_flash:

  

Flameshot is a free and open-source screenshot tool for Linux that allows users to take screenshots of an area, a window or the full screen. It then provides an editor where users can modify the screenshots by drawing on them, adding text, highlighting areas, blurring parts and more. Users can save the screenshots in common image formats like PNG and JPEG, and upload them directly to image hosting sites like Imgur.

• Docusaurus

  282 52,824 9.5 TypeScript

  Easy to maintain open source documentation websites.

  

Docusaurus is a static-site generator. It builds a single-page application with fast client-side navigation, leveraging the full power of React to make your site interactive. It provides out-of-the-box documentation features but can be used to create any kind of site (personal website, product, blog, marketing landing pages, etc).

Suggest a related project