Skip to content

Commit

Permalink
Fix esdoc2-plugins github links
Browse files Browse the repository at this point in the history
  • Loading branch information
phgn0 committed Jan 7, 2018
1 parent 924fbc5 commit 4f0870a
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 24 deletions.
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@
- [Migration to v1.0](https://esdoc2.org/manual/migration.html)
- [v0.5 documentation](https://esdoc2.org/v0.5/index.html)
- **Feat**
- [esdoc2-publish-markdown-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-publish-markdown-plugin) PoC
- [esdoc2-flow-type-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-flow-type-plugin) PoC
- [esdoc2-typescript-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-typescript-plugin) PoC
- [esdoc2-react-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-react-plugin) PoC
- [esdoc2-jsx-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-jsx-plugin)
- [esdoc2-publish-markdown-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-publish-markdown-plugin) PoC
- [esdoc2-flow-type-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-flow-type-plugin) PoC
- [esdoc2-typescript-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-typescript-plugin) PoC
- [esdoc2-react-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-react-plugin) PoC
- [esdoc2-jsx-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-jsx-plugin)
- **Note**
- `v1.0.0` can not use. Because `v1.0.0` had been used in past.

Expand Down
2 changes: 1 addition & 1 deletion manual/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ esdoc2 supports Node.js(v6 or later)
esdoc2 displays the import path of class/function into the document.<br/>
However, the import path may be different from real import path because usually ES modules is transpiled to use it.

So, [esdoc2 Import Path Plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-importpath-plugin) converts import path to real import path.
So, [esdoc2 Import Path Plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-importpath-plugin) converts import path to real import path.

## Who's Using esdoc2
- [RxJS](http://reactivex.io/rxjs/)
Expand Down
24 changes: 12 additions & 12 deletions manual/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ esdoc2 provides a lot of features.
- [ES Module](#es-module)
- [Plugin Architecture](#plugin-architecture)

**Standard Features (via [esdoc2-standard-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-standard-plugin))**
**Standard Features (via [esdoc2-standard-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-standard-plugin))**
- [Publish HTML]()
- [Documentation Coverage](#documentation-coverage)
- [Documentation Lint](#documentation-lint)
- [Integration Test Codes](#integration-test-codes)
- [Integration Manual](#integration-manual)
- [Search Documentation](#search-documentation)
- [Type Inference](#type-inference)
- [and more](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-standard-plugin)
- [and more](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-standard-plugin)

**Other Features (via [various plugins](https://github.com/esdoc2/esdoc2-plugins))**
- [Inject Style](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-inject-style-plugin)
- [Inject Script](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-inject-script-plugin)
- [ECMAScript Proposal](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-ecmascript-proposal-plugin)
- [Flow](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-flow-type-plugin) [PoC]
- [TypeScript](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-typescript-plugin) [PoC]
- [JSX](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-jsx-plugin)
- [React](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-react-plugin) [PoC]
- [Publish Markdown](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-publish-markdown-plugin) [PoC]
- [Inject Style](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-inject-style-plugin)
- [Inject Script](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-inject-script-plugin)
- [ECMAScript Proposal](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-ecmascript-proposal-plugin)
- [Flow](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-flow-type-plugin) [PoC]
- [TypeScript](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-typescript-plugin) [PoC]
- [JSX](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-jsx-plugin)
- [React](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-react-plugin) [PoC]
- [Publish Markdown](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-publish-markdown-plugin) [PoC]
- [and more](https://github.com/esdoc2/esdoc2-plugins)

## Doc Comment and Tag
Expand Down Expand Up @@ -79,14 +79,14 @@ This is useful because you not need to see export style in source code.

<img src="./asset/image/feature/module1.png" class="screen-shot" width="500px">

And you may as well as use [esdoc2-importpath-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-importpath-plugin) to transform path.
And you may as well as use [esdoc2-importpath-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-importpath-plugin) to transform path.

Note: esdoc2 doesn't support commonjs.

## Plugin Architecture
esdoc2 adopts plugin architecture. So, almost all features are provided as plugins.

Especially [esdoc2-standard-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-standard-plugin) is a packaging plugin with major plugins.<br/>
Especially [esdoc2-standard-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-standard-plugin) is a packaging plugin with major plugins.<br/>
Normally we recommend using this plugin. There are various plugins in [esdoc2/esdoc2-plugins](https://github.com/esdoc2/esdoc2-plugins).

You can easily make plugins, and there are many [third party plugins](https://www.npmjs.com/search?q=esdoc2%20plugin&page=1&ranking=optimal).<br/>
Expand Down
12 changes: 6 additions & 6 deletions manual/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ esdoc2 v1.0 adopts plugin architecture. So, almost all features are provided as
Please change your config to load plugins.

## Using esdoc2-standard-plugin
Main features of esdoc2 were carved out to [esdoc2-standard-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-standard-plugin)
Main features of esdoc2 were carved out to [esdoc2-standard-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-standard-plugin)

Please use the plugin with the following config.

Expand All @@ -23,8 +23,8 @@ Especially [integration test codes](./config.html#integrate-test-codes-config) a
## Using Other Plugins
The following features were carved out to each plugins. If you want to use the features, please use the plugins.

- `config.includeSource` => [esdoc2-exclude-source-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-exclude-source-plugin)
- `config.styles` => [esdoc2-inject-style-plugin](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-inject-style-plugin)
- `config.scripts` => [esdoc2-inject-script-plugin](https://github.com/esdoc2/esdoc2-plugins/blob/master/esdoc2-inject-script-plugin)
- `config.experimentalProposal` => [esdoc2-ecmascript-proposal-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-ecmascript-proposal-plugin)
- Parsing JSX => [esdoc2-jsx-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/esdoc2-jsx-plugin)
- `config.includeSource` => [esdoc2-exclude-source-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-exclude-source-plugin)
- `config.styles` => [esdoc2-inject-style-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-inject-style-plugin)
- `config.scripts` => [esdoc2-inject-script-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-inject-script-plugin)
- `config.experimentalProposal` => [esdoc2-ecmascript-proposal-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-ecmascript-proposal-plugin)
- Parsing JSX => [esdoc2-jsx-plugin](https://github.com/esdoc2/esdoc2-plugins/tree/master/packages/esdoc2-jsx-plugin)

0 comments on commit 4f0870a

Please sign in to comment.