Commit graph

69 commits

Author SHA1 Message Date
Yangshun Tay
55e676cb25
misc: add command to run prettier on docs (#2102)
* misc: add command to run prettier on docs

* Fix GH issue template

* Fix tests

* Add prettier-docs command to precommit
2019-12-07 21:56:30 -08:00
Eric Carboni
b027db1b34 docs(v1): remove exclusive language (#1961)
* Initial commit to replace easy, easily, simple, just, of course

* Revert ordered list change
2019-11-11 14:06:54 -08:00
Eric Ponvelle
5b3859d00b docs(v1): document how to include Google Fonts (#1852)
* Update api-site-config.md

Added a piece of text from the set-up guide to enable Google Fonts.

* Update api-site-config.md

* Update api-site-config.md
2019-10-20 12:22:35 -07:00
endiliey
1f6db3dd5b docs: update siteconfig 2019-10-17 10:53:56 +07:00
Eric Ponvelle
9e7e9670b3 docs: add more info on cleanUrl siteconfig (#1847)
* Update api-site-config.md

Added a clarification to the cleanUrl property to set it false if the users intend to use docusaurus only offline.

* Update api-site-config.md

Added the copyright information.

* Update api-site-config.md
2019-10-17 10:41:24 +07:00
Vincent
a5853241e1 docs: fix documented type for the cleanUrl option (#1775) 2019-09-13 12:01:23 -07:00
Nick Baroni
f1415b9080 docs: change separateCSS to separateCss (#1735)
The correct property, referenced on the "Custom Pages" docs page, is `separateCss`.
2019-08-01 12:57:19 -07:00
Joel Marcey
b2fe2a65c8 docs: add more clarity about markdown fields (#1589)
I wanted to enable superscript and subscripting to a v1 site. It wasn't quite clear how to do it. @yangshun helped me figure it out. So I thought I would document it.
2019-06-07 12:55:24 -07:00
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
Yangshun Tay
64fdafbcea fix: replace use of deepmerge with _.merge (#1430) 2019-05-02 22:00:28 +07:00
pkowaluk
866f66241b docs: change parameter type for separateCss from string to array (#1358) 2019-04-12 00:56:06 -07: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
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
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
Tan Li Hau
1275005321 docs: reorganize siteConfig entry (#436) (#1027) 2018-10-12 09:00:24 -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
Hilu luke
969399c6c5 Enable passing attributes to scripts and links (#937) 2018-09-03 15:46:55 -07: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
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
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
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
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
aae106c018 Enable Facebook comments on blog posts (#673)
* Enable comment on blog post

* adjust css

* Tweak
2018-05-19 09:26:57 -07:00
Endilie Yacop Sucipto
f8521c2fe1 Enhance footer with Facebook and Twitter buttons (#666)
* enhance footer with social media buttons

* Update api-site-config.md

* Update Footer.js

* fix minor issue on social-footer

* update facebookAppId description in api-site-config

* rm heading & pad footer social button

* Update api-site-config.md
2018-05-17 21:26:06 -07:00
Erin Teo
5771549e75 Rename latestVersion to defaultVersion (#639)
* Rename lastVersion to defaultVersion

* Added defaultVersionShown to site-config doc

* Remove defaultVersionShown from siteConfig

* Update api-site-config.md
2018-05-05 17:24:39 -07:00
Fabrizio Ruggeri
976ae770b5 Allow Google Analytics to use gtag.js (#601)
* Moved google analytics script to head

The code now uses the new gtag script to track the website on google analytics.
The migration is explained [here](https://developers.google.com/analytics/devguides/collection/gtagjs/migration).
This will help to solve issues such as #375.
As indicated at https://support.google.com/analytics/answer/1008080
the analytics code must be placed in the head tag, so it is moved there.

* Add a boolean to use the new gtag library

* Update api-site-config.md
2018-04-29 10:44:11 -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
huang.xinghui
aa32ff4a55 Add customize highlight.theme custom path support (#517)
* add themeUrl option to support custom theme file path

* Update api-site-config.md
2018-04-19 08:04:49 -07:00
Joel Marcey
47d08bf1da
Update site config example in docs 2018-04-17 21:15:50 -07:00
Joel Marcey
e738bbd99e
Add twitterImage to siteConfig options (#580) 2018-04-17 21:04:39 -07:00
Joel Marcey
bc3eef1b00
Update siteConfig example and docs (#544) 2018-04-10 10:00:04 -07:00
Yangshun Tay
632ccfb8cd Fix typo and formatting in docs (#523) 2018-04-03 18:51:51 -10:00
Joel Marcey
ce4d2f02b2
Add link to Facebook Pixel page 2018-03-14 18:05:17 -07:00
Pablo Estevez
508090377e Add Facebook Pixel ID setting (#507) 2018-03-14 18:01:23 -07:00
Joel Marcey
d2f414c5d3
Add more docs for Algolia 2018-03-12 16:49:21 -07:00
Joel Marcey
f1893d5fea
Add secondary, page-specific navigation documentation (#498)
And enable for docusaurus.io
2018-03-12 16:27:37 -07:00
Miralem Drek
a8d7299ef2 Add ogImage to site-config docs (#487)
Fixes #451
2018-03-07 13:10:32 -08:00
Joel Marcey
f093790947
Add blogSidebarCount to the site config Docs (#480) 2018-02-28 16:32:59 -08:00
Ozan Araz
0da690db57 Organize siteConfig.js options documentation page better #436 (#437) 2018-02-06 08:03:50 -08:00
Joel Marcey
62893dfe28
Add some more information around wrapPagesHTML (#426) 2018-01-31 19:53:50 -08:00
Joel Marcey
edbb869e26
Add more details on configurable fonts (#409) 2018-01-21 20:10:04 -08:00
jonathan-cowling
a241a46669 Make font-family as configurable parameter(#220) (#294)
We look for fonts object within siteConfig.js
2018-01-21 19:54:52 -08:00
Filip Danić
65085b1337 document changes from PR #206 (as per issue #212) (#380) 2018-01-08 08:22:46 -08:00