summaryrefslogtreecommitdiff
path: root/node_modules/snekfetch/docs.js
diff options
context:
space:
mode:
author8cy <[email protected]>2020-04-03 02:37:42 -0700
committer8cy <[email protected]>2020-04-03 02:37:42 -0700
commit60867fb030bae582082340ead7dbc7efdc2f5398 (patch)
tree4c6a7356351be2e4914e15c4703172597c45656e /node_modules/snekfetch/docs.js
parentcommenting (diff)
downloads5nical-60867fb030bae582082340ead7dbc7efdc2f5398.tar.xz
s5nical-60867fb030bae582082340ead7dbc7efdc2f5398.zip
2020/04/03, 02:34, v1.2.0
Diffstat (limited to 'node_modules/snekfetch/docs.js')
-rw-r--r--node_modules/snekfetch/docs.js55
1 files changed, 55 insertions, 0 deletions
diff --git a/node_modules/snekfetch/docs.js b/node_modules/snekfetch/docs.js
new file mode 100644
index 0000000..06b2876
--- /dev/null
+++ b/node_modules/snekfetch/docs.js
@@ -0,0 +1,55 @@
+const Docma = require('docma');
+const Package = require('./package');
+
+Docma.create()
+ .build({
+ app: {
+ title: Package.name,
+ base: '/',
+ entrance: 'content:readme',
+ routing: 'query',
+ server: Docma.ServerType.GITHUB,
+ },
+ markdown: {
+ gfm: true,
+ tables: true,
+ breaks: false,
+ pedantic: false,
+ sanitize: false,
+ smartLists: false,
+ smartypants: false,
+ tasks: false,
+ emoji: true,
+ },
+ src: [
+ { readme: './README.md' },
+ { snekfetch: './src/index.js' },
+ ],
+ dest: './docs',
+ jsdoc: {
+ plugins: ['jsdoc-dynamic'],
+ },
+ template: {
+ options: {
+ title: Package.name,
+ navItems: [
+ {
+ label: 'Readme',
+ href: '?content=readme',
+ },
+ {
+ label: 'Documentation',
+ href: '?api=snekfetch',
+ iconClass: 'ico-book',
+ },
+ {
+ label: 'GitHub',
+ href: Package.homepage,
+ target: '_blank',
+ iconClass: 'ico-md ico-github',
+ },
+ ],
+ },
+ },
+ })
+ .catch(console.error); // eslint-disable-line no-console