Skip to content

patch: use marked 0.6.0 to support id generation for headers #966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 17, 2019
Merged

patch: use marked 0.6.0 to support id generation for headers #966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b8c2d42
Support new feature with ids in headers
Beraliv Feb 5, 2019
e37203b
test: example for test
Beraliv Feb 6, 2019
a6b8301
test: add dummy md test
Beraliv Feb 6, 2019
73f6c32
prod: remove converter test
Beraliv Feb 11, 2019
aa2cd4d
test: add README.md cyrillic cases
Beraliv Feb 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions examples/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,14 @@ $ examples --out path/to/documentation/ path/to/example/project/

* `--example <project>`<br>
Example explanation.


## Example with Cyrillic

### Пример API

> Combined Latin and Cyrillic text

### Только кириллица

> Only Cyrillic text
40 changes: 13 additions & 27 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@
"@types/handlebars": "^4.0.38",
"@types/highlight.js": "^9.12.3",
"@types/lodash": "^4.14.110",
"@types/marked": "^0.4.0",
"@types/marked": "^0.6.0",
"@types/minimatch": "3.0.3",
"@types/shelljs": "^0.8.0",
"fs-extra": "^7.0.0",
"handlebars": "^4.0.6",
"highlight.js": "^9.13.1",
"lodash": "^4.17.10",
"marked": "^0.4.0",
"marked": "^0.6.0",
"minimatch": "^3.0.0",
"progress": "^2.0.0",
"shelljs": "^0.8.2",
Expand Down
9 changes: 9 additions & 0 deletions src/test/renderer/specs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,15 @@ <h3 id="arguments">Arguments</h3>
<li><code>--example &lt;project&gt;</code><br>
Example explanation.</li>
</ul>
<h2 id="example-with-cyrillic">Example with Cyrillic</h2>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first case, only Latin, should be with hyphen as it was

<h3 id="пример-api">Пример API</h3>
Copy link
Contributor Author

@Beraliv Beraliv Feb 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

second case, combined Latin and Cyrillic
it would be id="-api" without patching

<blockquote>
<p>Combined Latin and Cyrillic text</p>
</blockquote>
<h3 id="только-кириллица">Только кириллица</h3>
Copy link
Contributor Author

@Beraliv Beraliv Feb 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

third case, only Cyrillic
it would be id="-" without patching

<blockquote>
<p>Only Cyrillic text</p>
</blockquote>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down