Skip to content

Commit

Permalink
fix: migrate from ESDoc to JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
homer0 authored Jul 14, 2020
2 parents 4905fec + 56072b5 commit 65ab6cd
Show file tree
Hide file tree
Showing 46 changed files with 2,680 additions and 2,902 deletions.
5 changes: 4 additions & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{
"root": true,
"plugins": ["homer0"],
"extends": ["plugin:homer0/node"]
"extends": [
"plugin:homer0/node",
"plugin:homer0/jsdoc"
]
}
43 changes: 43 additions & 0 deletions .jsdoc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
const packageJson = require('./package.json');

module.exports = {
source: {
include: ['./browser', './node', './shared'],
includePattern: '.js$'
},
plugins: [
'docdash/nativeTypesPlugin',
'jsdoc-ts-utils',
'plugins/markdown',
],
templates: {
cleverLinks: true,
default: {
includeDate: false
}
},
opts: {
recurse: true,
destination: './docs',
readme: 'README.md',
tutorials: './documents',
template: 'node_modules/docdash'
},
docdash: {
title: packageJson.name,
meta: {
title: `${packageJson.name} docs`,
},
sectionOrder: [
'Modules',
'Tutorials',
],
collapse: true,
menu: {
'GitHub': {
href: `https://github.com/${packageJson.repository}`,
target: '_blank',
},
},
},
};
164 changes: 0 additions & 164 deletions README-esdoc.md

This file was deleted.

4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,9 @@ I use [ESlint](http://eslint.org) to validate all our JS code. The configuration

### Documentation

I use [ESDoc](http://esdoc.org) to generate HTML documentation for the project. The configuration file is on `./.esdocrc` and the script that runs it is on `./utils/scripts/docs`.
I use [JSDoc](https://jsdoc.app) to generate an HTML documentation site for the project.

The configuration file is on `./.jsdoc.js` and the script that runs it is on `./utils/scripts/docs`.

### To-Dos

Expand Down
Loading

0 comments on commit 65ab6cd

Please sign in to comment.