Commit graph

135 commits

Author SHA1 Message Date
Joshua Chen
0c4dc00443
feat(content-docs): allow omitting enclosing array consistently for category shorthand (#6602)
* feat(content-docs): allow omitting enclosing array consistently for category shorthand

* update snapshot

* fix doc
2022-02-04 11:16:08 +08:00
Joshua Chen
1ca07f8466
refactor(content-docs): read category metadata files before autogenerating (#6586)
* refactor(content-docs): read category metadata files before autogenerating

* fix tests

* fix Windows...

* warn user when behavior is undetermined

* oops

* fix typo
2022-02-03 16:16:19 +08:00
Jody Heavener
6ec0db4722
feat(content-docs): sidebar item type "html" for rendering pure markup (#6519)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-02 18:38:35 +01:00
Joshua Chen
3573b5e4a9
fix(content-docs): render category with no subitems as a normal link (#6495) 2022-02-02 14:45:00 +01:00
Joshua Chen
c1e3801ee7
fix(cli): allow passing a list of file names to write-heading-ids (#6500) 2022-01-29 12:21:15 +08:00
Joshua Chen
5c447b1ca3
docs: elaborate on Markdown asset linking; document pathname:// (#6404) 2022-01-27 23:16:55 +08:00
Joshua Chen
3c58d7f027
feat(content-docs): allow explicitly disabling index page for generated category (#6452)
* feat(content-docs): allow explicitly disabling index page for generated category

* docs

* add test
2022-01-27 23:14:07 +08:00
Joshua Chen
b8fbf7c530
docs: remove mention that CDN resources are caches cross-domain (#6484) 2022-01-27 19:21:07 +08:00
Pranab Das
f415da1c95
refactor: self-host KaTeX assets (#6429)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-27 11:39:45 +01:00
Joshua Chen
24a895fbc5
feat(content-docs): expose isCategoryIndex matcher to customize conventions (#6451)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-01-26 17:58:52 +01:00
Joshua Chen
59022c5eea
docs: add advanced guides (#6296)
* docs: add advanced guides

* complete

* fix link

* Create architecture

* use png

* explanations

* more text

* process.env.NODE_ENV

* typo

* Add image zoom

* nit

* nit

* reorganize

* fix links

* fix links

* reorganize

* elaborate on presets

* fix

* routing docs

* ssr section

* more content

* complete SSR guide

* pathname://

* improvements

* document executionenvironment

* reformat

* final tweaks!

* avoid slug

* oops
2022-01-25 11:29:18 +08:00
Nick Schonning
521eb119a7
chore: add cSpell for spell checking (#6456)
* chore: Add cSpell for spell checking

* chore: exclude map files and remove dups

* chore: exclude more binary files

* chore: remove MD headings

* Update .cspell.json

* fix a few spellings

* fix more

* fix

Signed-off-by: Joshua Chen <sidachen2003@gmail.com>

* fix a few

* oops

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-25 09:40:02 +08:00
Joshua Chen
711a6fe3d0
docs: document embedding generated index in doc page (#6453)
* docs: document embedding generated index in doc page

* fix
2022-01-23 20:04:34 +08:00
Joshua Chen
01676329e1
docs: split sidebar documentation into sections (#6450)
* docs: split sidebar documentation into sections

* set slugs

* fix links
2022-01-23 17:50:48 +08:00
Joshua Chen
8140560332
docs: multiple doc improvements (#6449) 2022-01-23 15:49:28 +08:00
Joshua Chen
3d7ba337c2
refactor(mdx-loader): use vfile.path to access Markdown file path (#6443) 2022-01-22 22:28:50 +08:00
Joshua Chen
e40cafccd5
chore: enable stylelint standard config (#6442)
* chore: enable stylelint standard config

* remove empty line

* fix
2022-01-22 21:26:35 +08:00
Joseph
8ce3cee400
feat(theme-classic): auto-collapse sibling categories in doc sidebar (#3811)
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2022-01-20 16:38:16 +01:00
Joshua Chen
45f1b819b5
feat(content-docs): displayed_sidebar front matter (#5782) 2022-01-19 16:00:42 +01:00
Joshua Chen
6c0da3ee4b
refactor: clean up TODO comments (#6399) 2022-01-19 12:10:50 +08:00
Nick Schonning
9f9a96dc80
chore: upgrade lint-staged and globs (#6369) 2022-01-15 16:33:09 +08:00
Pranab Das
99dbf1a121
docs: minor fix in the sample config for ESM (#6340)
The line `return config;` was left by mistake I guess. The function is already returning the `config` object.
2022-01-14 19:24:55 +08:00
Pranab Das
4ebb1ca8c8
chore: upgrade rehype-katex with ESM support, update docs (#6320)
* chore: upgrade rehype-katex to latest version with ESM support and update the docs

* Update documentation to reflect ESM upgrade is currently optional

* rewording

* final tweaks

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-14 09:06:10 +08:00
Morooka Kotaro
4aaa48759d
docs: remove typo bracket (#6327)
* docs: remove typo bracket

* fix in latest version

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-13 15:13:50 +08:00
Nick Schonning
02a233a221
chore: minor typo cleanup (#6324)
* chore: minor typo cleanup

* fix tests

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-13 14:36:53 +08:00
Joshua Chen
217b62682d
feat(mdx-loader): preserve hash in image src; support GH themed images (#6323)
* feat(mdx-loader): preserve hash in image src; support GH themed images

* more refactor
2022-01-13 10:22:48 +08:00
Joshua Chen
ba352271e7
fix(website): wrap details in mdx-code-block (#6308) 2022-01-10 20:35:39 +08:00
Joshua Chen
c7da6f5dd3
docs: document MD and JSX interoperability issues (#6307) 2022-01-10 20:05:33 +08:00
Joshua Chen
06a8cdcb0f
docs: elaborate on doc versioning (#6280)
* docs: elaborate on doc versioning

* Complete

* fix
2022-01-07 14:28:48 +08:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting (#6223) 2021-12-30 10:51:00 +08:00
Joshua Chen
c45281a581
feat(theme-classic): usable CodeBlock outside markdown (#6216) 2021-12-29 17:17:09 +01:00
Joshua Chen
96dbb8e7ef
feat(website): improve prism themes (#6214)
* feat(website): modify Prism dark theme

* update

* Use vsDark

* update crowdin config

* fix light theme as well

* revert comment changes
2021-12-29 21:25:01 +08:00
Joshua Chen
0fa091a0c2
docs: use BrowserWindow for Markdown demos (#6215) 2021-12-29 13:49:09 +08:00
Joshua Chen
6a772828c5
docs: add default value for BrowserWindow URL field (#6207)
* docs: fix BrowserWindow URL field

* fix
2021-12-28 15:19:23 +08:00
Joshua Chen
4f2330a824
docs: recommend highlighting with comments than number range (#6204)
* docs: recommend highlighting with comments than number range

* quick fix
2021-12-28 10:55:24 +08:00
Joshua Chen
73ee356949
docs: audit grammar issues (#6203)
* docs: audit grammar mistakes

* fix code block language

* revert change

* let's get another
2021-12-27 19:34:04 +08:00
Joshua Chen
8cd593379c
docs: fix react live scope button color in dark mode (#6191) 2021-12-25 16:50:14 +08:00
Joshua Chen
3889e89380
fix(theme-classic): make React elements in pre render correctly (#6177)
* fix(theme-classic): make React elements in pre render correctly

* Properly fix

* Use MDX

* Add docs

* Better comment

* Update code-block-tests.mdx
2021-12-25 15:27:29 +08:00
Pranab Das
e4f9ab072c
chore: upgrade rehype-katex and katex stylesheet for website (#6172)
* chore: Update rehype-katex and katex stylesheet for doc website

* Reformat

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-23 14:24:56 +08:00
Joshua Chen
5dcfa8fa23
docs: fix import module name of theme/Admonition (#6164) 2021-12-22 22:11:11 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders (#6142) 2021-12-21 14:56:29 +01:00
Joshua Chen
cb4265253a
feat(theme-classic): standalone Admonition component (#5848) 2021-12-20 17:51:19 +01:00
Yangshun Tay
faef753730
docs: mention admonition quirks with Prettier (#6135)
* docs: mention admonition quirks with Prettier

* Update markdown-features-admonitions.mdx

* Update markdown-features-admonitions.mdx

* Update markdown-features-admonitions.mdx
2021-12-20 12:14:50 +08:00
Himanshu
c0a99786b3
docs: elaborate on "docs-only" and "blog-only" (#6131)
* rephrased documentation

* Rewording

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-20 09:29:43 +08:00
Joshua Chen
18cb13d6cc
docs: refactor docs sidebar doc (#6130)
* docs: refactor docs sidebar doc

* Edits
2021-12-19 19:08:59 +08:00
Drylozu
fa3926e2a1
feat(theme-classic): allow passing additional attributes to tab headings (#6082)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-17 18:23:50 +01:00
Joshua Chen
f84eb073e7
docs: mention that SEO through front matter is better than head tag (#6112) 2021-12-17 12:29:51 +01:00
Joshua Chen
7db4884853
refactor(website): make deploy preview open next version docs by default (#6120)
* refactor(website): make deploy preview open next version docs by default

* Fix links
2021-12-17 11:00:12 +08:00
Sébastien Lorber
cfae5d0933
feat(content-docs): sidebar category linking to document or auto-generated index page (#5830)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Armano <armano2@users.noreply.github.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-12-03 14:44:59 +01:00
Oliver Ullman
1366c31201
feat(core): allow sourcing from multiple static directories (#4095)
* [WIP] Implementaion of multiple directory static sourcing

* Move default to validation

* Update test

* Refactor

* Port to MDX loader

* Fix

* Move dogfooding assets

* Doc writeup

* Restore assets

* Support absolute paths

* Dogfood absolute path

* Fix

* More tests

* Fix snapshots

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-18 22:26:26 +08:00