mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
6003ea7e26
1. The test data is taken from tests, you can override attributes by adding keyword params to `doc` macro; 2. Additionally, you can add a section title using a `@moduledoc` in a controller and a controller action title using `@doc` on a controller function. (It will be added to all instances of its usage). 3. To make parameters nice a helper was added to build it using `DocHelper`, you can find an example in UserController. Overall, the code is messy, I'll need to revisit it, but was doing it in a rush so hope it's good enough for v0. Results you can see at https://firezone.docs.apiary.io/. To generate it locally run `DOC=1 mix test test/fz_http_web/controllers/json`. Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>
44 lines
1.1 KiB
JSON
44 lines
1.1 KiB
JSON
{
|
|
"name": "firezone-docs",
|
|
"version": "0.0.0",
|
|
"private": true,
|
|
"scripts": {
|
|
"docusaurus": "docusaurus",
|
|
"start": "docusaurus start",
|
|
"build": "docusaurus build",
|
|
"swizzle": "docusaurus swizzle",
|
|
"deploy": "docusaurus deploy",
|
|
"clear": "docusaurus clear",
|
|
"serve": "docusaurus serve",
|
|
"write-translations": "docusaurus write-translations",
|
|
"write-heading-ids": "docusaurus write-heading-ids"
|
|
},
|
|
"dependencies": {
|
|
"@docusaurus/core": "^2.1.0",
|
|
"@docusaurus/preset-classic": "^2.1.0",
|
|
"@docusaurus/theme-search-algolia": "^2.1.0",
|
|
"@mdx-js/react": "^1.6.22",
|
|
"clsx": "^1.1.1",
|
|
"markdownlint-cli": "^0.31.1",
|
|
"prism-react-renderer": "^1.3.3",
|
|
"react": "^17.0.2",
|
|
"react-dom": "^17.0.2"
|
|
},
|
|
"devDependencies": {
|
|
"@docusaurus/module-type-aliases": "2.1.0",
|
|
"css-minimizer-webpack-plugin": "4.1.0"
|
|
},
|
|
"browserslist": {
|
|
"production": [
|
|
">0.5%",
|
|
"not dead",
|
|
"not op_mini all"
|
|
],
|
|
"development": [
|
|
"last 1 chrome version",
|
|
"last 1 firefox version",
|
|
"last 1 safari version"
|
|
]
|
|
}
|
|
}
|