Commit graph

259 commits

Author SHA1 Message Date
TurekBot
cb7c6f34b9 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
2019-05-16 19:20:27 -07:00
TurekBot
a7b19c083a 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.
2019-05-16 19:17:47 -07:00
TurekBot
2a48b83ff2 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
2019-05-16 16:03:59 -07:00
Yangshun Tay
c84860d9fa
doc: remove references to F8 in tutorial (#1432)
* doc: remove references to F8 in tutorial

* misc: use correct bold syntax

* misc: fix path
2019-05-02 19:16:05 -07:00
Yangshun Tay
64fdafbcea fix: replace use of deepmerge with _.merge (#1430) 2019-05-02 22:00:28 +07:00
Yangshun Tay
2fe73edc22
docs: add versioning to tutorial (#1413)
* docs: add versioning to tutorial

* docs: address Endilie's comments
2019-04-29 09:51:42 -07:00
Yangshun Tay
ecf1f9a2c4 docs: remove example mentions 2019-04-27 22:01:09 -07:00
Wilson Mar
9426b033ee docs-examples-from-docusaurus is now installed as doc (#1406)
docs: docs-examples-from-docusaurus is now installed as doc
2019-04-27 21:09:09 -07:00
Juan Picado @jotadeveloper
7ebcf10478 fix: blog docs example as object property (#1403) 2019-04-27 09:45:43 -07:00
Yangshun Tay
16fe5196cb fix: use class names for tutorial images 2019-04-23 11:36:51 -07:00
Yangshun Tay
23e56f61f5
feat: add tutorial (#1381)
* feat: add tutorial

* feat: complete tutorial

* Fix link
2019-04-23 09:44:37 -07:00
Yangshun Tay
21793a833d
feat: docusaurus-init without example directories (#1378)
* feat: do not copy into examples folder

* Update documentation

* feat: use Undraw illustrations for initialized landing page (#1379)
2019-04-21 22:28:35 -07:00
pkowaluk
866f66241b docs: change parameter type for separateCss from string to array (#1358) 2019-04-12 00:56:06 -07:00
Parth Patel
d279836c40 feat: Add --skip-next-release option to yarn build (#1292) 2019-03-29 16:17:46 +07:00
Yangshun Tay
edec1a9eda misc: s/Circle CI/CircleCI 2019-03-26 23:16:34 -07:00
Yangshun Tay
431510e9ab fix: broken links due to monorepo migration 2019-03-26 22:03:53 -07:00
Endilie Yacop Sucipto
643addb729
feat(v2): enable JSX in markdown using MDX (#1263)
* feat(v2): enable JSX in markdown

* reformat docs

* chore(v2): nits

* remove dummy test

* include .mdx extension

* add syntax highlighting with prismjs
2019-03-08 01:02:47 +08:00
Adel El Masery
48f95219a8 docs: update api-pages.md to document about overriding default styles (#1266)
docs: update api-pages.md to document about overriding default styles
2019-03-06 13:41:02 -08:00
Yangshun Tay
f559b1dc7c refactor(v2): move website dir out of v2 for cleaner separations 2019-02-24 14:13:08 -08:00
Yangshun Tay
1efaabc158
docs: mention about CNAME option in publishing docs (#1227)
* docs: mention about CNAME option in publishing docs

* Update getting-started-publishing.md
2019-02-08 21:15:59 +08:00
Yangshun Tay
dcd3361413 misc: update docs for new features 2019-01-23 23:20:11 -08:00
Fienny Angelina
5ce85e5b5e feat: code block tab (#1063)
* Try to find a way to recognize the codeblock tabs, its title, and
where it ends
- I try using DOCUSAURUS_CODE_TABS to mark the start
- Use TAB_TITLE to mark the title of the tab
- END_TAB to mark the end of that tab
- END_DOCUSAURUS_CODE_TABS to mark the end of the whole code blocks
then parse using regex and render accordingly

* Added on click hook

* Added example on how to write it, how to use it, how it will look like can be reverted later

* Fix css error

* - Move addEventListener part to lib/static
- Remove comments

* Add documentation

* Remove examples

* Change syntax of the codetabs
2019-01-23 21:48:01 -08:00
tsmrachel
d5fd15ecbe feat: collapsible categories (#1128)
* feat : #1084 Collapsus - The Collapsible Menu

* updated docs

* fixed prettier

* fix for category not auto-expanding upon navigating to a subcategory under it

* as requested by endiliey. Do not merge this commit.

* Update api-site-config.md

* Update guides-navigation.md

* Update SideNav.js

* Update main.css

* Update SideNav.js

* Delete subcategory1.md

* Delete subcategory2.md

* Update sidebars.json
2019-01-23 14:13:27 -08:00
Marvin Chin
3ff79fceb1 docs: add missing trailing slash to sample site config base url (#1190) 2019-01-18 09:31:02 -08:00
Jake Bolam
c4a9b31984 feat: add custom commit message (#1136)
* feat: add custom commit message

Addresses: #1135

* Update publish-gh-pages.js

* add support to v2 as well

* docs: add them

* docs
2018-12-04 12:26:21 +08:00
Dom Corvasce
61078e38a9 feat: Allow modifying docs url prefix (#914)
* Allow other routes than /docs in the URL

siteConfig.js has a new mandatory field named *docsRoute* which default
value is 'docs' and that can be customized by the user.

This change will allow users who uses the library to host guides and
tutorials to customize their websites by assign 'docsRoute' values
like 'tutorials' or 'guides'.

Fixes #879

* Make "docsRoute" field optional

* Isolate docsRoute login in getDocsRoute function

* Rename docsRoute to docsUrl

* Run prettier

* Remove old folders

* fix: Restore docusaurus reference link

* fix: Add `docsUrl` param fallback. Refactor multiple function calls

* Fix linting errors

* Update description for docsUrl field

* Reduce redundant calls to getDocsUrl

* Replace a missed use case for `docsUrl` instead of the function call

* Move `getDocsUrl` out from `server/routing.js` to `server/utils.js`

**Why?**
Because `routing.js` is exporting all router RegEx's, and the
`getDocsUrl` suffices more as a util

* WiP: Align leading slashes and fix routing around `docsUrl`

Checklist:
- [x] Added `removeDuplicateLeadingSlashes` util to make sure there is only
one leading slash
- [-] Fix edge cases for routing:
  - [x] `docsUrl: ''`
  - [ ] `docsUrl: '/'`
  - [ ] make it work with languages
  - [ ] make it work with versioning

* Make leading slashes canonical cross routing and generated links

This ensures correct routing for customized `baseUrl` and `docsUrl`.

- Changed all routing functions to take `siteConfig` instead of
`siteConfig.baseUrl`
- Updated tests accordingly

* Alternative fallback for `docsUrl`

* rework/ fix implementation

* cleanup

* refactor and add docs for config props

* fix typo

* fix broken url
2018-11-28 15:34:16 +08:00
maxaggedon
c6f3f0958d feat: customizable search placeholder (#1126)
* feat: customizable search placeholder

* prettier
2018-11-23 14:27:59 -08:00
maxaggedon
2df14feafd feat: use 'sidebar_label' instead of 'title' in prev/next buttons (#1122)
* feat: use 'sidebar_label' instead of 'title' in prev/next buttons

* docs: update 'sidebar_label' description
2018-11-22 18:36:05 +08:00
tsmrachel
54b76628f1 docs: specify markdown flavor support (#1118)
* docs : #1108 specify markdown flavor support

* Update api-doc-markdown.md
2018-11-18 21:07:57 -08:00
Alexandre ZANNI
2bf2dfe173 docs: mention about website directory naming (#1106)
docs: mention about website directory naming
2018-11-11 15:14:39 -08:00
Andrew Shillito
8c7d89c667 docs: add info about setting custom doc path (#1098)
* docs: add info about setting custom ../docs folder name

* Update getting-started-preparation.md
2018-11-07 21:59:55 -08:00
aenuros
edde297504 docs: how to add "Copy" button to code blocks (#1047)
* Update guides-custom-pages.md

Guide on how to add "Copy" to clipboard buttons on code blocks in Docusaurus.

* Update guides-custom-pages.md

Changed wall of text to be a link to a gist describing the code you need to add to add copy clipboard

* Add to markdown instead

* Update guides-custom-pages.md
2018-10-24 01:52:55 -04:00
Yangshun Tay
ca7c3cebc1
docs: remove extra comma in site creation steps 2018-10-22 17:45:34 -04:00
M4rk9696
d1ced5ca13 docs: reword publish to GitHub Pages documentation (#1049)
* doc: Updating Using GitHub Pages Documentation

* docs: Rewording deploying to github pages

* docs: Review changes

* Update getting-started-publishing.md
2018-10-20 21:15:06 -07:00
Fienny Angelina
8cf9afe4ac feat: add last contributor to each document (#980)
* add contributor list to each document

* handle case where there is no github repo

* Move to v1

* Revert "handle case where there is no github repo"

This reverts commit a76a887901.

* Revert "add contributor list to each document"

This reverts commit c0cc79f995.

* Add last updated by field

* -Include enableUpdateBy in the config
- Rename css class to be more general

* Fix lint

* Refactor :
- s/getGitlastupdated/getGitLastUpdatedTime
- refactor part in getGitLastUpdated[Time|By] that overlaps
- remove getAuthorInformation

* -Modify the display logic
-Refactor the utils, combine lastupdatedtime and lastupdatedby
-Replace the test

* Modify docs based on the display change

* Update docs for url and baseurl

For more clarity and to make relationship more clear

* Update support for Web App Manifest (#1046)

* misc: update nits

* misc: update nits
2018-10-18 00:59:16 -07:00
Tirth Bodawala
4a7e1ea189 Update support for Web App Manifest (#1046) 2018-10-17 10:21:10 -07:00
Joel Marcey
a39d2b0280
Update docs for url and baseurl
For more clarity and to make relationship more clear
2018-10-17 10:20:35 -07:00
Alex Driedger
a28ac3bf93 docs: update siteConfig documentation for publishing with GitHub Pages (#1038)
* Updated Publishing with GitHub Pages

Updated docs to resolve #1029

* Update getting-started-publishing.md
2018-10-15 10:18:22 -07:00
Tan Li Hau
1bc1762b02 docs: document process.env.BROWSER for start command (#1034)
* docs: document BROWSER

* Update api-commands.md
2018-10-14 12:28:50 -07:00
Tan Li Hau
1275005321 docs: reorganize siteConfig entry (#436) (#1027) 2018-10-12 09:00:24 -07:00
Yangshun Tay
fe500dea82
fix: change subcategory format (#1026)
* fix: change subcategory format

* Fix sidebars

* Refactor

* Fix implementation

* Change format
2018-10-10 08:33:20 -07:00
Will Brock
954456088c feat: sub-categories in sidebar.json (#892)
* Add ability to specify sub categories in sidebar.json

* move v1 files to correct place

* refactor implementation

* refactor naming for implementation clarity
2018-10-08 16:09:29 +08:00
Amy Lam
a364aa531c Fix typo in Getting Started docs (#1013) 2018-10-01 22:41:08 -07:00
Marvin Heilemann
8568a96e65 Added option for client to include there own remarkable config (#974)
* Added option for client to include there own remarkable config

* Better use merge here

* Added lodash ...

* Change use of lodash to deepmerge and added description to api site

* markdownConfig -> markdownOptions

* Update api-site-config.md

* remove 1.4 docs change

 since it is unrelated (the feature will only be available in next release)

* Run prettier
2018-09-20 15:00:59 +08:00
Eric Nakagawa
ac01fcf881
Merge pull request #936 from wszgxa/add-docker-support
Add docker support
2018-09-06 11:20:11 -07:00
Eric Nakagawa
3094afdce3 Rewrote some of the new Docker copy. 2018-09-06 11:13:13 -07:00
endiliey
b00b933ab9 docs nit 2018-09-06 01:59:16 +08:00
Ethan Marrs
4bc010bfcc Fix minor documentation wording issue (#945)
* The phrase "It has no inherit meaning" should probably be "It has no inherent meaning".
2018-09-05 17:36:07 +08:00
Hilu luke
969399c6c5 Enable passing attributes to scripts and links (#937) 2018-09-03 15:46:55 -07:00
hiluluke
a1a26d1c2e Add docker support document 2018-09-03 13:21:06 +08:00