3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-09 23:27:28 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update siteConfig example and docs (#544)

Browse source
This commit is contained in:
Joel Marcey 2018-04-10 10:00:04 -07:00 • committed by GitHub
parent bbbe311004
commit bc3eef1b00
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -53,6 +53,8 @@ headerLinks: [
`noIndex` - Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.
`organizationName` - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.
`projectName` - Project name. This must match your GitHub repo project name (case sensitive).
`tagline` - Tagline for your website.
@ -136,8 +138,6 @@ h1 {
- `separate` - The secondary navigation is a separate pane defaulting on the right side of a document. See http://docusaurus.io/docs/en/translation.html for an example.
`organizationName` - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.
`scripts` - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.
`separateCss` - Folders inside which any `css` files will not be processed and concatenated to Docusaurus' styles. This is to support static `html` pages that may be separate from Docusaurus with completely separate styles.
@ -175,17 +175,17 @@ const siteConfig = {
baseUrl: "/",
// For github.io type URLS, you would combine the url and baseUrl like:
// url: "https://reasonml.github.io",
// url: "/reason-react/",
// baseUrl: "/reason-react/",
organizationName: "facebook",
projectName: "docusaurus",
noIndex: false,
// For no header links in the top nav bar -> headerLinks: [],
headerLinks: [
{ doc: "doc1", label: "Docs" },
{ page: "help", label: "Help" },
{ search: true },
{ blog: true }
],
// For no header links in the top nav bar -> headerLinks: [],
headerIcon: "img/docusaurus.svg",
favicon: "img/favicon.png",
colors: {
@ -193,6 +193,7 @@ const siteConfig = {
secondaryColor: "#205C3B"
},
editUrl: "https://github.com/facebook/docusaurus/edit/master/docs/",
// users variable set above
users,
disableHeaderTitle: true,
disableTitleTagline: true,

35
examples/basics/siteConfig.js
View file

@ -5,6 +5,9 @@
* LICENSE file in the root directory of this source tree.
*/
// See https://docusaurus.io/docs/site-config.html for all the possible
// site configuration options.
/* List of projects/orgs using your project for the users page */
const users = [
{
@ -18,25 +21,41 @@ const users = [
const siteConfig = {
title: 'Test Site' /* title for your website */,
tagline: 'A website for testing',
url: 'https://facebook.github.io' /* your website url */,
baseUrl: '/test-site/' /* base url for your project */,
url: 'https://your-docusaurus-test-site.com' /* your website url */,
baseUrl: '/' /* base url for your project */,
// For github.io type URLs, you would set the url and baseUrl like:
// url: 'https://facebook.github.io',
// baseUrl: '/test-site/',
// Used for publishing and more
projectName: 'test-site',
organizationName: 'facebook',
// For top-level user or org sites, the organization is still the same.
// e.g., for the https://JoelMarcey.github.io site, it would be set like...
// organizationName: 'JoelMarcey'
// For no header links in the top nav bar -> headerLinks: [],
headerLinks: [
{doc: 'doc1', label: 'Docs'},
{doc: 'doc4', label: 'API'},
{page: 'help', label: 'Help'},
{blog: true, label: 'Blog'},
],
// If you have users set above, you add it here:
users,
/* path to images for header/footer */
headerIcon: 'img/docusaurus.svg',
footerIcon: 'img/docusaurus.svg',
favicon: 'img/favicon.png',
/* colors for website */
colors: {
primaryColor: '#2E8555',
secondaryColor: '#205C3B',
},
/* custom fonts for website */
/*fonts: {
myFont: [
@ -48,20 +67,24 @@ const siteConfig = {
"system-ui"
]
},*/
// This copyright info is used in /core/Footer.js and blog rss/atom feeds.
copyright:
'Copyright © ' +
new Date().getFullYear() +
' Your Name or Your Company Name',
// organizationName: 'deltice', // or set an env variable ORGANIZATION_NAME
// projectName: 'test-site', // or set an env variable PROJECT_NAME
highlight: {
// Highlight.js theme to use for syntax highlighting in code blocks
theme: 'default',
},
scripts: ['https://buttons.github.io/buttons.js'],
// You may provide arbitrary config keys to be used as needed by your template.
repoUrl: 'https://github.com/facebook/test-site',
// You may provide arbitrary config keys to be used as needed by your
// template. For example, if you need your repo's URL...
// repoUrl: 'https://github.com/facebook/test-site',
/* On page navigation for the current documentation page */
// onPageNav: 'separate',
};