Skip to content

Commit

Permalink
doc(faq): update api
Browse files Browse the repository at this point in the history
  • Loading branch information
h13i32maru committed Jan 2, 2017
1 parent b0dfd2f commit c676a0a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
4 changes: 2 additions & 2 deletions www/-/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body {
}

h2 {
margin: 20px 0 0 0;
margin: 1.25em 0 0 0;
}

h2:first-child {
Expand All @@ -16,7 +16,7 @@ h2:first-child {

h2 + p {
margin: 4px 0;
line-height: 1.25;
line-height: 1.75;
}

a {
Expand Down
22 changes: 14 additions & 8 deletions www/-/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ <h2>What is ESDoc?</h2>
For more information is <a href="https://esdoc.org">esdoc.org</a>
</p>

<h2>Zero config hosting(without esdoc.json)</h2>
<h2>How to update documentation via hands</h2>
<p>Update with your hand at <a href="./generate.html">here</a>

<h2>How to update documentation via API</h2>
<p>
If your repository satisfy the following conditions, enable zero config hosting(without esdoc.json).
<br/>
- ES2015 codes are exist in <code>/src</code> directory<br/>
- <code>/package.json</code> is exist
You can update documentation using API.
A sample script is <a href="https://github.com/esdoc/esdoc-hosting/blob/master/script/update-example.sh">here</a>
</p>

<h2>Documentation Coverage Badge</h2>
Expand All @@ -44,9 +45,6 @@ <h2>Documentation Coverage Badge</h2>
<h2>Support repositories</h2>
<p>Now, supports only GitHub.</p>

<h2>Update documentation</h2>
<p>Update with your hand at <a href="./generate.html">here</a>

<h2>Support ECMAScript Proposal</h2>
<p>
You can see <a href="https://esdoc.org/manual/usage/feature.html#ecmascript-proposal">Feature: ECMAScript Proposal</a>.
Expand All @@ -63,6 +61,14 @@ <h2>Can not use property in config</h2>
- <code>esdoc-importpath-plugin</code>
</p>

<h2>Zero config hosting(without esdoc.json)</h2>
<p>
If your repository satisfy the following conditions, enable zero config hosting(without esdoc.json).
<br/>
- ES2015 codes are exist in <code>/src</code> directory<br/>
- <code>/package.json</code> is exist
</p>

<h2>Feedback</h2>
<p>Please report using <a href="https://github.com/h13i32maru/esdoc-hosting">GitHub Issue</a></p>

Expand Down

0 comments on commit c676a0a

Please sign in to comment.