Git Product home page Git Product logo

api-docs's Introduction

ServicePOS OpenAPI site

Setup (development)

Run npm run start to start a local instance of the ReDoc site - be aware that this dosen't watch for changes in the pages markdown

Pages

Extra information like code examples and general information about the api is organized in the pages folder. Here sections are seperated in their one markdown files, during the build process, the files are merged into one single markdown file which is used to generate the static html.

Scripts

npm run build: This bundles the pages markdown, then fetches the remote openapi.json from here and builds a zero-dep static html file from that.

Changing the theme and html

To update/change the theme edit the theme.json file, available theme options can be found at ReDoc docs

To change the html (change font, favicon etc) edit the index-template.hbs

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.