https://github.com/dadi/docs
The complete documentation of the DADI framework
https://github.com/dadi/docs
documentation
Last synced: 10 months ago
JSON representation
The complete documentation of the DADI framework
- Host: GitHub
- URL: https://github.com/dadi/docs
- Owner: dadi
- Created: 2016-05-13T13:59:53.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-09-13T15:35:54.000Z (almost 7 years ago)
- Last Synced: 2025-04-19T19:14:17.760Z (about 1 year ago)
- Topics: documentation
- Language: CSS
- Homepage: https://docs.dadi.cloud/
- Size: 111 MB
- Stars: 21
- Watchers: 18
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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}
{@html app=attributes.product file=attributes._loc}{/html}
{/version.results}
```