* 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
* 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
* 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
* 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
* 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
* Add ability to specify sub categories in sidebar.json
* move v1 files to correct place
* refactor implementation
* refactor naming for implementation clarity
* 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
* 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
* 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
* 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
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.
* 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
* 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
* Introduce imagemin for compressing images
* Replace original images with the optimized ones
* Add imagemin-svgo to dependencies
* Remove console statement, replace let with const
* Replace let with const
* Add --skip-image-compression
* Run Prettier
* Simplifying DocSearch documentation
I slightly rewrote the DocSearch documentation. The main three points are:
- I explained a bit more how DocSearch works (trying to explain that it's an external service that requires the website to be online)
- I removed mentions to the _search_ API key as in that case, it's always a _search_ (as opposed to _admin_) API key that is used
- I removed the part about faceting on the version. I thought it was confusing as without a specific UI to display the faceting, this won't do much. To use it properly, one will need to dig more into layouts. I might submit a PR about that later, but as it was today I think it would just create confusing rather that adding value
Hope that helps :)
* Make links URLs inline
I tried following the guide to publish my website on Netlify (on April 29, 2018), however it did not work until I changed the path to include "website/".
* simplify installation steps
Since docusaurus-init is run seldomly, npx keeps it simpler,
and subsequent runs will be using the latest version.
Outdated provides more meaningful view of current and latest version
* add more doc on who can use npx
* Make yarn and npm commands more specific
* Rename authorImage to authorImageURL for clarity
Update documentation
* Fix typo
* Add documentation for authorImageURL
* Add support for authorImage
We will remove support for authorImage in favor of authorImageURL, after we remove authorImage from react-native-website
* Update guides-blog.md
* Update guides-blog.md
Yangshun Tay