dadi / Docs
The complete documentation of the DADI framework
Stars: ✭ 20
Labels
Projects that are alternatives of or similar to Docs
Platform Documentation
Core Platform API Documentation & Tutorials
Stars: ✭ 25 (+25%)
Mutual labels: documentation
Widdershins
OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown
Stars: ✭ 856 (+4180%)
Mutual labels: documentation
Docker Cheat Sheet
A collection of recipes for docker.
Stars: ✭ 18 (-10%)
Mutual labels: documentation
Doc Hunt
Keep your documentation up to date by tracking changes in your source code
Stars: ✭ 24 (+20%)
Mutual labels: documentation
Everything Curl
The book documenting the curl project, the curl tool, libcurl and everything related to this.
Stars: ✭ 885 (+4325%)
Mutual labels: documentation
Wsl Programs
A community powered list of programs that work (and those that don't) on the Windows subsystem for Linux
Stars: ✭ 931 (+4555%)
Mutual labels: documentation
Markdown Guide
The comprehensive Markdown reference guide.
Stars: ✭ 835 (+4075%)
Mutual labels: documentation
Wiki
Official repository for OCS Inventory documentaiton
Stars: ✭ 23 (+15%)
Mutual labels: documentation
Api schema
DSL for describing APIs and generate swagger json
Stars: ✭ 18 (-10%)
Mutual labels: documentation
Immutablejs For Beginners
This documentation is trying to help people who starts using FB immutable.js but at the same time feeling confused by the original documentation
Stars: ✭ 25 (+25%)
Mutual labels: documentation
Cht.exe
cht.sh libcurl client for windows XP+ with changed colorization
Stars: ✭ 15 (-25%)
Mutual labels: documentation
Incident Response Docs
PagerDuty's Incident Response Documentation.
Stars: ✭ 859 (+4195%)
Mutual labels: documentation
Parse Code Context
Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype properties, prototype methods etc.
Stars: ✭ 7 (-65%)
Mutual labels: documentation
Documentation
Install
$ npm install
Start
$ npm start
Edit
All markdown source files are in /docs/
Deploying
After deploying new or updated documentation to the server, you must run the build script to generate HTML files from the Markdown files in /docs
.
$ npm run build
Processing file /Users/james/projects/dadi/product/docs/docs/api-wrapper/2.0.md
Done.
Processing file /Users/james/projects/dadi/product/docs/docs/api-wrapper/3.0.md
Done.
Processing file /Users/james/projects/dadi/product/docs/docs/cli/2.1.md
Done.
Server
The website is using pm2
to manage the service. Restart the service after generating the HTML files:
-
pm2 log docs
- view logs -
pm2 show docs
- view status -
pm2 restart docs
- restart app -
pm2 monit
- monitor all pm2 processes
Style
Blockquotes
To add blockquotes that stand out, for tips/tricks/warnings, use the following format. Available types are advice
, warning
and danger
.
> **Security Note**
>
> We **strongly** recommend creating an Amazon IAM account specifically for accessing your S3 buckets.
> -- warning
Rendering static HTML files
A Dust helper @html
is available that loads the specified file from the file system:
{#version.results}
<div class="docs docs--{attributes.product}">
{@html app=attributes.product file=attributes._loc}{/html}
</div>
{/version.results}
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].