Giter Club home page Giter Club logo

libris-js's Introduction

Libris JavaScript Client

Libris Libris

Boost productivity with Libris: Automatically generate comprehensive modern documentation for your projects.

Libris Docs Banner

Libris

Libris is an advanced documentation generation tool that automates the process of code documentation. It is designed to seamlessly integrate with the existing code development workflow, making it easy for developers to generate comprehensive and up-to-date documentation.

Libris works by analyzing the codebase and extracting relevant information, such as function signatures, class hierarchies, and variable descriptions. It then organizes this information into a structured and user-friendly format, generating documentation that is easy to navigate and understand. Libris supports multiple programming languages, making it a versatile tool for different development environments.

  • Supports C++, C, JavaScript, Python, CLI and RESTAPI documentations.
  • Modern documentation layout.
  • Automatically generate documentation from source code and docstring comments.
  • Create custom pages using markdown, javascript and html.
  • Feedback features.
  • Embedded page analytics.
  • Custom themes.
  • Independent hosting.
  • Supports fully customizable syntax highlighting.
  • Supports GitHub Pages.
  • Embedded search console.

Documentation

More information regarding the libris client can be found in the documentation.

Integrating Libris

To document your code using Libris, simply place a structured comment block above the code you want to document. Libris will automatically parse important information such as the function name, return type, function keywords, parameters, templates, requires clause and more. The @docs tag is universal and can be used with all supported languages.

/*  @docs:
 *  @title: Load
 *  @description: Load a file.
 *  @parameter:
 *      @name: path
 *      @description: The path of the file.
 *  @usage:
 *      char* data = load("./myfile.txt");
 */
char*  load(const char* path) { ... }

More information can be found in the Documentation.

Obtain your API Key.

The Libris Client requires an API Key.

libris-js's People

Stargazers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.