Commit graph

225 commits

Author SHA1 Message Date
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
Tirth Bodawala
2cbfeffd81 Add support for Web App Manifest in siteConfig (#934)
* Add support for Web App Manifest in siteConfig

* Update api-site-config.md

* Update api-site-config.md
2018-09-02 10:25:15 -07:00
Shubham Bansal
1a572757f1 feat: last updated time in docs (#913)
* Adding last updated time for docs

* Making file path general and other suggested changes

* Checking if time returned is null due to absence of git or some other issue

* Adding option to enable/disable update time feature and test-doc

* Adding simple unit tests for getGitUpdateTime()

* nits & rewrote failing test

* consistent test naming

* Adding optional updateEnableTime in documentation

* package-lock & yarn.lock
2018-08-29 21:15:18 +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
Apurav Chauhan
acd4f3f984 Update getting started page to be more intuitive (#900)
* Updating step 2 to be more intuitive

Use of word Github is very confusing. When starting, most of devs wont have an existing github repo. And normally not everyone will be using Github. Since devs will be following this step by step: we need to stress on telling them to create a new or use existing local project folder which may or may not be a github repo.

* Update getting-started-installation.md
2018-08-13 01:29:45 -07:00
Yangshun Tay
d2b30dc3ed Revert "Add ability to specify sub categories in sidebar.json (#891)"
This reverts commit 16087b4428.
2018-08-06 18:58:54 -07:00
Will Brock
16087b4428 Add ability to specify sub categories in sidebar.json (#891) 2018-08-06 18:58:48 -07:00
Carol Willing
dd9d05c84d Clarify content in the site prep doc (#889) 2018-08-05 20:05:15 -07:00
Carol Willing
29e71ebf53 Update installation doc (#888)
* Update installation doc

* add short phrase
2018-08-05 15:45:24 -07:00
John Reese
75538395be Fix table of contents documentation typo (#873) 2018-07-27 11:07:56 +07:00
Fabrizio Ferri-Benedetti
a60fe1c052 Improve baseUrl documentation with an example (#863)
* Update with GH Enterprise instructions for baseUrl

* Update api-site-config.md

* simplify wordings
2018-07-20 22:33:27 +07:00
Steve Hook
22f3a85a49 add documentation regarding usage of nested docs + git ignore .idea (#860)
* add documentation regarding usage of nested docs + add .idea in .gitignore

* Remove 1.3.3, move to navigation & simplify wording

* add documentation for docusaurus >= v1.2.0 a well
2018-07-19 16:07:32 +07:00
Endilie Yacop Sucipto
aa1f82649c
Search correct language and version for Docusaurus (#859) 2018-07-18 17:39:04 +07:00
Yangshun Tay
1094dbd352
CSS revamp - Improve typography and overall styling (#757)
* Improve CSS code

* Fix blog layout

* Fix

* Refactor onPageNav

* More fixes

* Fix docs nav

* Use alternative hack

* Tweak clearfix
2018-06-19 21:46:15 -07:00
Andrey Rublev
850e3003ca [docs] add note about babel cache to upgrade guide (#778)
for details see https://github.com/facebook/Docusaurus/issues/759
2018-06-15 10:32:35 -07:00
Jonathan Ingram
58fba70dea Add config option for setting title of the blog sidebar (#770)
* Allow controlling the title of the blog sidebar

* Update guides-blog.md
2018-06-15 00:08:34 -07:00
=^._.^=
62a2c7c1a5 Add option to disable live reload server during development (#766)
* add option to disable live reload server

* change live to watch, fix incorrect argument parsing code

* Update api-commands.md
2018-06-14 23:51:03 -07:00
Joel Marcey
608e2c85a2
Move custom translation strings to its own file (#775) 2018-06-14 17:25:29 -07:00
Gustavo Henke
fd9a3ffb6d Cross repo publishing (#764) 2018-06-14 16:03:37 -07:00
Joel Marcey
de8da1ca54
Better bash formatting for updating Docusaurus 2018-06-11 17:46:58 -07:00
Joel Marcey
7281c5632b
More details on updating Docusaurus for a site 2018-06-11 16:53:04 -07:00
Joel Marcey
902db36edb
Fix broken search guide formatting 2018-06-10 17:37:43 -07:00
Tim Kelly
976df54419 Add back information about extra search options (#756)
I added back information about extra search options for Algolia. A previous commit removed the section about extra search options, but it appears the information might actually be useful.
2018-06-10 17:32:04 -07:00
Endilie Yacop Sucipto
c47af6be4b Enable custom meta description for custom pages (#752) 2018-06-10 09:35:30 -07:00
Yangshun Tay
18c01327a3 Reformat, proofread and tidy up docs (#749) 2018-06-10 08:02:04 -07:00
Yangshun Tay
ffe782a669
Remove outdated restriction for docs nesting (#746) 2018-06-10 01:21:06 -07:00
Endilie Yacop Sucipto
c8bc00a3a7 Enable using Prism for syntax highlighting (#735)
* Enable user to use prism.js as syntax highlighter

* add package-lock

* if 'usePrism' is true, use prismjs on all languages

* don't get lang by hljs if use prism

* Update api-site-config.md

* Update api-doc-markdown.md

* only load prism css when usePrism is true
2018-06-09 11:38:01 -07:00
vacarsu
16da2fdbf6 Update getting-started-installation.md (#742)
* Update getting-started-installation.md

Add minimum yarn version

* Add a period

* Update getting-started-installation.md
2018-06-08 17:09:34 -07:00
Endilie Yacop Sucipto
d04b3ca87b Enable sub-directories in docs/ (#705) 2018-06-07 07:41:28 -07:00
Endilie Yacop Sucipto
31f0c27f81 Enable clean / extension-less url (#677) 2018-06-06 13:37:49 -07:00
Lespagnol Rémy
aee255219b Add a scroll to top button siteConfig option (#723) 2018-06-06 12:34:32 -07:00
ranolf
2bd9a148c1 Support publishing to Github Enterprise hosting (#689)
* Added support for Github Enterprise GH Pages

* Fixed with prettier output

* Tweak

* Tweak

* Tweak
2018-06-02 15:59:29 -07:00
Endilie Yacop Sucipto
e91e648844 Add Travis CI guide (#721) 2018-06-02 11:25:13 -07:00
Endilie Yacop Sucipto
fa20c93d5c Add documentation for setting title of custom pages (#712)
* add customtitle for page doc

* Update api-pages.md

* Update api-pages.md
2018-05-30 22:16:50 -07:00