Commit graph

23 commits

Author SHA1 Message Date
Hongarc
f18e07343c docs: fix typo for docs folder (#1484)
* docs: fix typo for `docs` folder

* docs: request change for #1484

* Update api-doc-markdown.md
2019-05-17 10:26:55 -07: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
Laxman
cfabaedc99 Fix: conflicting strings issue in translations (#917)
* Fix conflicting strings issue in translations

* Preserve structure of `customTranslations`

* Use `deepmerge` to merge whole of `localized-strings`

* Simplify and make deep property access on an object safe

* Fix deep property accessor and rename it to idx
2018-08-29 00:04:02 +08:00
Joel Marcey
92f95df934
Update guides-translations.md for CircleCI 2.0
Ref: #350
2018-08-20 10:48:05 -07:00
Joel Marcey
608e2c85a2
Move custom translation strings to its own file (#775) 2018-06-14 17:25:29 -07:00
Yangshun Tay
18c01327a3 Reformat, proofread and tidy up docs (#749) 2018-06-10 08:02:04 -07:00
Endilie Yacop Sucipto
d04b3ca87b Enable sub-directories in docs/ (#705) 2018-06-07 07:41:28 -07:00
Yangshun Tay
a9a39817d4
Use proper syntax highlighting for code blocks (#615)
* Better syntax highlighting

* Better syntax highlighting
2018-04-27 22:51:38 -07:00
Yangshun Tay
6500f9bacf More doc improvements (#532)
* Generic doc improvements

* Convert to Markdown

* Remove whitespace

* More typo fixes
2018-04-07 21:16:29 -07:00
Yangshun Tay
632ccfb8cd Fix typo and formatting in docs (#523) 2018-04-03 18:51:51 -10:00
Joel Marcey
1add5dcbb2
Update translation docs
Do not integrate `CROWDIN` variables within `package.json`
2018-03-08 11:45:34 -08:00
Joel Marcey
e48b6bbf66
Rearrange and provide more information for translations 2018-03-08 11:10:47 -08:00
Cheng Lou
00270c26a7 i18n: use zh-TW and zh-CN over zh-Hant and zh-Hans (#377)
Both crowdin and docsearch i18n configs use TW and CN over Hant and Hans. This should reduce some config confusions.
cc @ericnakagawa. Also, apparently you're working on algolia search i18n?
2018-01-11 15:40:53 -08:00
Thomas Broadley
b5fefcc676 docs: fix typos (#327) 2017-12-19 21:39:18 -08:00
Joel Marcey
70bd56eb93 Update translations guide 2017-11-17 14:38:37 -08:00
Christine Abernathy
4a198ae5b2 Specify crowdin.yaml location (#215)
Minor update to specify where crowdin.yaml is located
2017-11-08 16:38:48 -08:00
Eric Nakagawa
fcc168af42 Add more info around syncing to crowdin 2017-10-24 15:31:52 -07:00
Eric Nakagawa
5617987bf2 Added a note about disabling English as a language 2017-10-24 15:23:18 -07:00
Eric Nakagawa
fdc8b1ba72 Add a link to the crowdin-cli download instructions 2017-10-24 15:19:13 -07:00
Eric Nakagawa
bcba05ae03 Adds sitemap.xml. Adds 'Help Translate' to translatable strings. Error messages and fn name cleanups. (#136)
* added a note about needing more than one language to be enabled to allow for a drop down

* Removing debug statements

* Add 'Help Translate' to translatable strings, improves error messages around missing translated strings, calls write-translations on some routes

* Adds sitemap.xml to live server and build. Versioning not supported. -- Also did some file name and module cache cleanups.
2017-10-18 12:55:58 -07:00
Eric Nakagawa
8e9808c0f4 Re-arranging of files to move localized base files in /docs from /docs/en, updates to template crowdin.yaml, update to package.json to make calling crowdin easier. Updating documentation to reflect. 2017-09-21 08:36:30 -07:00
Eric Nakagawa
d379f58581 Adding crowdin config to Docusaurs. Content updates to: README.md, guides-translation.md. Moved docs into /docs/en. 2017-09-20 21:09:55 -07:00
Frank Li
5f09602440 Rename documents 2017-08-15 14:07:02 -07:00
Renamed from docs/translation.md (Browse further)