3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-04 11:52:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

Support publishing to Github Enterprise hosting (#689)

Browse source 
* Added support for Github Enterprise GH Pages

* Fixed with prettier output

* Tweak

* Tweak

* Tweak
This commit is contained in:
ranolf 2018-06-02 15:59:29 -07:00 • committed by Yangshun Tay
parent 93b2ebb53b
commit 2bd9a148c1
3 changed files with 24 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api-site-config.md
View file

@ -62,7 +62,7 @@ headerLinks: [
`title` - Title for your website.
`url` - url for your site.
`url` - URL for your website.
### Optional Fields
@ -131,6 +131,8 @@ h1 {
`gaGtag` - Set this to `true` if you want to use [global site tags (gtag.js)](https://developers.google.com/gtagjs/) for Google analytics instead of `analytics.js`.
`githubHost` - Hostname of your server. Useful if you are using GitHub Enterprise.
`highlight` - [Syntax highlighting](api-doc-markdown.md) options:
* `theme` is the name of the theme used by Highlight.js when highlighting code. You can find the [list of supported themes here](https://github.com/isagalaev/highlight.js/tree/master/src/styles).

10
docs/getting-started-publishing.md
View file

@ -204,3 +204,13 @@ Steps to configure your Docusaurus-powered site on Netlify.
1. Click **Deploy site**
You can also configure Netlify to rebuild on every commit to your repo, or only `master` branch commits.
### Publishing to GitHub Enterprise
GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.
| Name | Description |
| ------------- | ----------------------------------------------- |
| `GITHUB_HOST` | The hostname for the GitHub enterprise server. |
Alter your `siteConfig.js` to add a property `'githubHost'` which represents the GitHub Enterprise hostname. Alternatively, set an environment variable `GITHUB_HOST` when executing the publish command.