Coder Social home page Coder Social logo

slate's Introduction

Arylic API Documentation

This is a fork of the Slate project. To study its original documentation please visit their Wiki.

How it works

Arylic boards provides three different API's which are accessible via:

  • HTTP
  • TCP and
  • UPnP

The documentation is written in pure Markdown, and all documentation files are placed in their API specific directories:

  • source/includes/http/ for HTTP API
  • source/includes/tcp/ for TCP API, and
  • source/includes/upnp/ for UPnP API

When you edit the documentation, you usually do this by running the ./slate.sh serve command side-by-side to be able to see live your changes in the browser. Using this command without any additional parameter will serve the HTML documentation by default.

If you want to see live changes for the TCP documentation, then you have to use the -t or --target parameter, setting by one of three possible targets:

  • html (in this case the target parameter can also be omitted)
  • tcp, or
  • upnp

This will result in a command like:

./slate.sh -t tcp serve

for watching live changes of your TCP documentation.

To get it work properly, besides the documentation files in source/includes/$TARGET there are three Markdown index files:

  • html-index.md
  • tcp-index.md, and
  • upnp-index.md

These files contains the final structure of the generated static documentation. By running the serve, build or deploy command, the index file in question will be copied to index.html.md which will be used by Slate finally.

slate's People

Contributors

anfedorov avatar blackxored avatar bootstraponline avatar chrissrogers avatar coliff avatar cvkef avatar dependabot-preview[bot] avatar djpowers avatar dlackty avatar greysteil avatar jdahdah avatar kevin-buttercoin avatar lord avatar maks3w avatar marcguyer avatar masterodin avatar mccricardo avatar mikeralphson avatar nwt-stuff avatar phranck avatar pomier avatar prayagverma avatar readmecritic avatar realityking avatar rezanachmad avatar rickyrauch avatar ritesh99rakesh avatar rlord avatar sobstel avatar victorquinn avatar

Stargazers

 avatar  avatar  avatar

Watchers

 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.