Skip to content

Commit 40747c0

Browse files
committed
(docs) add README/usage to readthedocs
1 parent 60ff004 commit 40747c0

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

docs/index.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,20 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Developer Documentation
7-
=======================
6+
Highlight.js Documentation
7+
==========================
8+
9+
.. toctree::
10+
:caption: Getting Started
11+
:maxdepth: 1
12+
13+
14+
README / How to Use <readme>
15+
building-testing
816

9-
Contents
10-
--------
1117

1218
.. toctree::
13-
:caption: Documentation
19+
:caption: Reference
1420
:maxdepth: 1
1521

1622
api
@@ -21,21 +27,16 @@ Contents
2127
css-classes-reference
2228
style-guide
2329
plugin-recipes
24-
language-contribution
25-
building-testing
2630
.. maintainers-guide
2731
28-
FAQ
29-
^^^
30-
3132
.. toctree::
3233
:caption: FAQ
3334
:maxdepth: 1
3435

35-
What languages are supported? <supported-languages>
36-
What about line numbers? <line-numbers>
37-
How do I request a language be added? <language-requests>
38-
How do I contribute a language? <language-contribution>
36+
Which languages are supported? <supported-languages>
37+
Why no line numbers? <line-numbers>
38+
How do I request a new language? <language-requests>
39+
How do I contribute a new language? <language-contribution>
3940

4041

4142

@@ -46,7 +47,6 @@ Links
4647
- Discord: https://discord.gg/M24EbU7ja9
4748
- Issues: https://github.com/highlightjs/highlight.js/issues
4849
- NPM:
49-
5050
- https://www.npmjs.com/package/highlight.js
5151
- https://www.npmjs.com/package/@highlightjs/cdn-assets
5252
- Website: https://highlightjs.org

docs/readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md
File renamed without changes.

0 commit comments

Comments
 (0)