Commit graph

361 commits

Author SHA1 Message Date
Endi
ae678c9dad feat(v2): add editUrl option to docs plugin (#1818)
* feat(v2): add editUrl option to docs plugin

* nits

* misc(v2): nit

* misc(v2): nit
2019-10-10 11:10:18 -07:00
Yangshun Tay
17252a079c
feat(v2): make sidebar collapsible (#1817)
* feat(v2): make sidebar collapsible

* fix first page load sidebar category not collapsed

* misc(v2): nit
2019-10-09 08:11:51 -07:00
Wei Gao
4ce1b582cf docs(v2): document plugins and lifecycle APIs (#1724)
* wip docs(v2): lifecycle apis

* docs(v2): edit advanced plugins

* wip plugins & lifecycle api docs

* wip plugins doc

* Update advanced-plugins.md

* misc: update plugins docs

* misc: remove excessive line
2019-10-08 00:23:03 -07:00
Endi
95f0552bad feat(v2): allow infinitely nested sidebar (#1812)
* feat(v2): allow infinitely nested sidebar

* Update markdown-features.mdx

* Update sidebar.md

* Update sidebar.md
2019-10-07 11:52:43 -07:00
Endi
f671e6b437
docs(v2): simple migration guide from v1-v2 (#1809)
* docs(v2): simple migration guide from v1-v2

* fix wrong info

* add gitignore section

* proofread migration guide

* typo

* publish dir

* proofread
2019-10-06 09:29:47 +07:00
Dattatreya Tripathy
a404732c30 docs(v2): blog initial draft (#1786)
* docs(v2): contributing for v2 #1640

* deleted blog.md

* docs(v2): contributing for v2 (#1640)

* docs(v2): blog (#1640)

* Update blog.md
2019-10-05 12:23:21 -07:00
Wei Gao
9eb725d53a docs(v2): make double nested sidebar entry thinner and smaller (#1756) 2019-10-05 12:06:48 -07:00
endiliey
7d5920b30c docs(v2): fix outdated/ wrong info 2019-10-05 15:39:22 +07:00
endiliey
8d4def5c08 v2.0.0-alpha.25 2019-10-01 20:29:26 +07:00
endiliey
9806b44a6d chore: fix expired discord invite link 2019-09-25 17:05:54 +07:00
Sakti Kr Chourasia
4ecdd98cc8 fix(v2): make feedback page compatible with dark mode (#1742)
* docs: make navbar less cluttered

* misc(v2): rename components (#1434)

* misc(v2): clean up work

* misc(v2): rename components

* misc(v2): rename Blog components

* refactor(v2): remove page plugin component

* chore(v2): optimize webpack config

* feat(v2): implement theme component overriding (#1435)

* feat(v2): implement component overriding

* siteDir theme overriding should work for > 1 level directory

* fallback for essential component like Loading

* rename default -> classic

* fix(v2): add missing layout alias on theme-classic plugin

* feat(v2): easier plugin theme components swizzling (#1436)

* feat(v2): easier plugin theme components override

* add context

* refactor again

* rename eject -> swizzle

* nits

* fix(v2-cli): passes the missing host option to start (#1439)

* feat(v2): Algolia search theme (#1440)

* feat(v2): Algolia search plugin

* patch PR #1440 (#1441)

* alternative implementation

* typo

* refactor noop

* rename SearchAlgolia -> SearchBar

* changes.md

* refactor(v2): move headerLinks -> themeConfig & rm dead code (#1442)

* refactor(v2): move headerLinks -> themeConfig & rm dead code

* rm -rf dead code

* chore(v2): better chunk naming

* refactor(v2): add flowtype + refactor test (#1443)

* chore(v2): add flow setup

* nits

* fix

* add flow-typed

* ignore compiled library

* fix error

* fix typing

* fix module name mapper

* setup for @docusaurus/core

* dont try remove type without @flow

* fix can't find @docusaurus/utils

* fix test

* remove obscure relative paths

* more refactoring

* add typing for server/load/theme.js

* no need to ship .flow source

* chore(v2): rm flowtype (#1444)

* chore(v2): tweak eslint config (#1445)

* chore: point website-1.x to correct version so that it can pick latest code

* feat(v2): meta description (#1447)

* feat(v2): meta description

* add description for blog as well

* fix non-descriptive text link

* remove font awesome

* switch front-matter -> gray-matter

* fix(v2): docsearch a11y issue (#1449)

* refactor(v2): blog data revamp (#1450)

* refactor(v2): blog data revamp

* fix(v2): fix incorrect blog total count

* misc: remove console.log

* feat(v2): export frontMatter as an object within MDX file (#1451)

* refactor. Don't confuse metadata & frontmatter

* export frontMatter in content itself

* nits

* nits name

* dont truncate first four lines in blog

* fix(v2): transpiling, window scroll and console error (#1452)

* chore(v2): better error message style (#1454)

* chore(v2): remove docsearch a11y workaround

* fix(v2): slugify tags

* feat(v2): blog tags (#1453)

* feat(v2): blog tags

* feat(v2): blog tags

* chore(v2): use remark-slug so that rightToc can benefit from it

* fix: right TOC should not strip special chars (#1458)

* fix: right TOC should not strip special chars

* nits

*  fix(v2): handle non existent blog, docs, pages (#1459)

* fix(v2): handle non existent blog, docs, pages

* nits

* feat(v2): list blog tags on posts (#1456)

* feat(v2): list blog tags on posts

* fix date handling on blog header

* fix console log error due to non unique key

* test(v2): test different type of sidebar item

* chore(v2): fix typo

* v2.0.0-alpha.14

* fix(v2): fix wrong dependency problem (#1460)

* v2.0.0-alpha.15

* Chore(v2): use alias instead of relative path for blogpost

* feat(v2): theme config for Footer (#1461)

* feat(v2): theme config for Footer

* fix: dont show footer if themeConfig.footer is undefined
* Import fresh docusaurus.config.js for better hot reload

* chore(v2): update dependencies (#1462)

* chore(v2): update dependencies

* nits

* v2.0.0-alpha.16

* fix(v2): fix cannot import css from node_modules in userland (#1463)

* docs: showcase user Express Validator (#1464)

* docs: sort user with alphabetical (#1465)

* chore: fix typo (#1466)

* docs: showcase user tipsi-stripe (#1423)

* docs: make it clear in the tutorial where the `docs` folder is (#1468)

* Make it clear where the `docs` folder is

It was not clear, to the beginner user—who this tutorial is for—where the `docs` folder was . The only reason I know this is because I'm a beginner user and I tried for too many minutes to find the `docs` folder inside the `website` folder. I had this assumption because the previous example is offered under the assumption that you're in the `website` folder.

Feel free to change the wording, I just want to make it clear where you should be looking, if you're new.

* Update tutorial-create-pages.md

* docs: add hint for linking dependencies time (#1470)

In this tutorial we assume that the user may or may not have used Node.js. It would follow then, based on how long it takes the "Linking dependencies" step to complete—243.61s for me—that we give them a hint that it might take a minute.

* doc: mention HTTPS approach in tutorial git clone step (#1471)

* doc: change tutorial git to suggest HTTPS

Since we're instructing the user to create a new repository, it might be a safe bet to assume that they don't have their SSH keys set up. HTTPS might be a better option in this context.

* docs: keep ssh add https

@Hongarc said, "How about keep `SSH` and add `HTTPS`." This is one way to do that.

* Update tutorial-setup.md

* docs: normalized spelling of `web server` (#1473)

* docs: clarify location of sidebars.json (#1472)

In #1468 we clarify where the `docs` folder is. 
Here, we make it clear where `sidebars.json` is.

* fix: missing cli commands (#1478)

* fix: missing cli commands

* centralize

* feat(v2): move navbar config into themeConfig (#1477)

* feat(v2): move navbar config into themeConfig

* misc: fix tests

* fix: support external url for logo

* docs(v2): CLI docs (#1476)

* WiP: CLI docs

* Tweak word choices for CLI docs

- Use the word swizzle directly
- Follow variable convention for shell

* Resolve docs discussion

* Update cli.md

* fix(v2): should be able to build even if static folder doesnt exist (#1479)

* chore: remove noWatch cli options because you cant disable watch in wds (#1480)

* docs: update StreamPipes logo (#1481)

* docs: showcase user Ax (#1483)

* docs: remove pinned for Taro (#1482)

* docs: fix typo for `docs` folder (#1484)

* docs: fix typo for `docs` folder

* docs: request change for #1484

* Update api-doc-markdown.md

* docs: add some showcase user of `facebook` (#1486)

* docs: showcase user Idb

* docs: showcase user Netconsd

* docs: showcase user Redex

* added css for feedback page contrast issue
2019-08-04 14:31:47 -07:00
Endi
d6d113b1df
docs(v2): search - algolia and custom (#1734)
* docs(v2): search - algolia and custom

* revisions
2019-08-02 11:11:32 +07:00
Wei Gao
2ebfc94ccb chore(v2): typos (#1726) 2019-07-29 19:13:59 -07:00
Wei Gao
4344b1a87d
docs(v2): deploy to netlify (#1719) 2019-07-28 16:48:24 +08:00
Endi
7ce6edc1b1
feat(v2): disable optimization.removeAvailableModules for webpack performance (#1711) 2019-07-26 22:42:03 +07:00
Wei Gao
f4f458460c docs(v2) themes (#1645)
* More prep

* rename xxx-api to api-xxx

* move content around for plugins and themes

* wip docs: using themes

* docs(v2): tweak using plugins

* docs(v2): list official themes in docs

* docs(v2): advanced themes

* wip notes for lifecycle apis

* resolve PR review discussions

* lower case "theme"

* better intro for using themes

* add a simple README to @docusaurus/theme-classic

* remove list of components from theme classic README and replace with link to directory
2019-07-26 12:00:40 +07:00
Wei Gao
162bfc43f8 docs(v2): contributing for v2 (#1700)
* docs(v2): contributing for v2

* remove link to docs
2019-07-25 16:23:01 +07:00
endiliey
41126fed12 v2.0.0-alpha.24 2019-07-24 15:55:28 +07:00
Endi
71aefbcddc
chore(v2): make feedback page accessible, not 404 (#1695)
* chore(v2): make feedback page accessible, not 404

* hack
2019-07-24 00:28:12 +07:00
Endi
1c59b5bc1c
chore(v2): upgrade deps and add missing docs on docusaurus config (#1693)
* chore(v2): upgrade deps and add missing docs on docusaurus config

* review
2019-07-23 23:06:15 +07:00
Wei Gao
f2864e0a91
docs(v2): analytics (#1678)
* docs(v2): analytics

* docs(v2): rework analytics docs

* fix broken link
2019-07-23 14:31:59 +08:00
Yangshun Tay
a684806a0f fix(v2): do not reveal environment file path (#1692)
* fix(v2): do not reveal environment file path

* changelog

* fix broken markdown linking
2019-07-23 13:12:21 +07:00
Leo Lamprecht
f1a504e813 docs: suggest ZEIT Now for quick deployment of 2.0 (#1691)
* Suggest quick deployments for Docusaurus 2.0

* Sub heading

* Sub heading

* Sub heading

* Sub heading

* Update getting-started-publishing.md

* Update getting-started-publishing.md

* Update getting-started-publishing.md

* Update getting-started-publishing.md

* Update deployment.md

* Added to auto-deploy section

* Added to auto-deploy section

* Added to auto-deploy section

* Added to auto-deploy section

* Mention Git integration

* Update deployment.md

* Update deployment.md
2019-07-22 13:55:00 -07:00
endiliey
f37269aaad v2.0.0-alpha.23 2019-07-21 11:18:03 +07:00
Wei Gao
2a1eb365fd
docs(v2): SEO (#1677)
* docs(v2): SEO

* docs(v2): add section on customized SEO

* remove unnecessary comment

* docs(v2): separate SEO doc and fix typos
2019-07-21 00:03:05 +08:00
endiliey
ae620cd530 v2.0.0-alpha.22 2019-07-20 18:31:41 +07:00
Endi
2d6aaea069 feat(v2): allow custom syntax highlighting theme (#1674) 2019-07-18 11:19:00 -07:00
Endi
0daed4abec feat(v2): optimize dev by omiting production only plugins (#1673) 2019-07-18 11:18:03 -07:00
Endi
52e67a1c35
chore(v2): fix landing page avatar (#1675) 2019-07-19 00:12:18 +07:00
Wei Gao
40cf5dcc56 docs(v2): subcategories (#1670)
* docs(v2): subcategories

* fix a typo and move call for pr to a comment till new side bar is implemented
2019-07-17 23:46:54 -07:00
Endi
b34ad721e4
feat(v2): @docusaurus/plugin-ideal-image (#1665)
* chore(v2): tweak image opt before moving to docusaurus-plugin-image

* lint

* feat(v2): convert to docusaurus-plugin-ideal-image

* tweak

* dont need many img

* fix dev err

* tweak

* opt png

* lower qual
2019-07-17 21:53:40 +08:00
Endi
bc5bceeb87 feat(v2): optimize image processing with sharp & lqip (#1663)
* feat(v2): optimize image processing

* cleanup
2019-07-14 11:28:16 -07:00
endiliey
dc15a51745 v2.0.0-alpha.21 2019-07-14 18:54:53 +07:00
endiliey
ea19b35e90 docs(v2): better install docs 2019-07-14 17:58:25 +07:00
endiliey
307f384684 v2.0.0-alpha.20 2019-07-14 17:36:40 +07:00
endiliey
568d9fd7dd chore(v2): update changelog 2019-07-14 17:32:48 +07:00
Yangshun Tay
281f02279f
feat(v2): add showcase page (#1660)
* feat(v2): add showcase page

* misc(v2): shift users out of pages to prevent it from being treated as a page

* misc(v2): update title
2019-07-13 21:44:40 -07:00
Yangshun Tay
c021367a18
docs(v2): proofread docs for alpha.20 (#1658)
* docs(v2): proofread docs for alpha.20

* docs(v2): update creating pages doc

* docs(v2): further updates to creating pages doc

* chore(v2): update CHANGELOG
2019-07-13 19:21:39 -07:00
Endi
d61cc01217
feat(v2): @docusaurus/init package (#1655)
* feat(v2): separate v2 docusaurus/init package

* nits

* docs

* rm unwanted

* readme
2019-07-14 01:06:23 +07:00
Endi
811cd9137e
chore: move bitcoin-s image logo to correct site (#1654)
* chore: move bitcoin logo to correct place

* optimize img
2019-07-13 20:22:44 +07:00
Endi
ca67cad2a7
feat(v2): add more essential meta tags (#1651)
* feat(v2): add more essential meta tags

* nits tagline
2019-07-13 01:23:00 +08:00
Anurag Goel
ee2050d612 docs: add Render hosting guide (#1615)
* Add Render deployment guide

* Add guide for Docusaurus 2

* Update guide for v2
2019-07-12 09:58:23 -07:00
Wei Gao
2491c53ba9 feat(v2): improve seo (#1588)
* feat(v2): improve seo

- Add doc specific seo information
- Add twitter meta tags to seo in theme Layout

* Cannot use svg in SEO image

* Add docs about SEO

* add site default image for seo

* Resolve PR discussion

* Add `image` to config optional fields

* Use theme config instead of root config for image, rename in front matter

* Use absolute url for image (wont work on preview)

* update docs for frontmatter field for seo

* refactor

* pages seo

* fix

* nits again'
2019-07-13 00:23:49 +08:00
Endi
295ee65bf8
docs(v2): add docs on static assets (#1648)
* docs(v2
): add docs on static assets

* Update static-assets.md
2019-07-12 11:01:37 +07:00
Wei Gao
95fde5f827 docs(v2): refactor docs for better outline and welcoming PRs (#1641)
* docs(v2): refactor docs for better outline and welcoming PRs

* docs(v2): update docs
2019-07-07 23:14:49 -07:00
Sam Zhou
75c7cffe97 docs(v2): add docs about CNAME support in deployment (#1637)
* Update deployment.md

* Update deployment.md

* Update deployment.md
2019-07-05 11:18:46 -07:00
Torkel Rogstad
1c0d5f0135 docs: add Bitcoin-S to users (#1635)
* Add Bitcoin-S to users list

* Update users.js
2019-07-04 18:37:34 -07:00
Wei Gao
03eae0f274 docs(v2): initialize doc on styling (#1626) 2019-07-02 23:13:09 -07:00
Wei Gao
504fcb1b4a docs(v2): plugins (#1629) 2019-07-02 23:12:22 -07:00
Wei Gao
d1418af5ba chore(v2): tweak installation doc (#1621)
- generated site to match what is described in the doc
- minor changes in the installation page
2019-06-23 10:32:10 -07:00