Skip to content

Commit

Permalink
updated docusaurus config
Browse files Browse the repository at this point in the history
  • Loading branch information
zackbradys committed Jun 30, 2023
1 parent f7b512e commit ba003c6
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 24 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
, , _______________________________
,-----------|'------'| | |
/. '-' |-' |_____________________________|
|/| | |
|/| | |
| .________.'----' _______________________________
| || | || | |
\__|' \__|' |_____________________________|
Expand All @@ -19,7 +19,7 @@
### Installing Dependencies (docusaurus)
```bash
git clone https://github.com/rancherfederal/carbide-docs
cd carbide-docs
cd carbide-docs
# install docusaurus & dependencies from package.json
npm install # make sure you are in the root of the dir containing `package.json`
Expand All @@ -38,13 +38,12 @@ npm run start # this will open your default browser to http://localhost:3000
[Official Docusaurus Documentation](https://docusaurus.io/docs/creating-pages)
## Publishing Content
This docs site is served using github-pages. There is an [action](.github/workflows/deploy.yml) that will trigger upon commit to the `main` branch and deploy the new build to https://rancherfederal.github.io/carbide-docs/.
This docs site is served using github-pages. There is an [action](.github/workflows/deploy.yml) that will trigger upon commit to the `main` branch and deploy the new build to https://rancherfederal.github.io/carbide-docs/.
## Contributing
- Fork this repository
- make changes
- commit and reference
- issue number
- Make your changes
- Commit changes and reference the Issue
- Submit Pull Request with changes
50 changes: 33 additions & 17 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ const config = {
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/rancherfederal/carbide-docs/edit/main',
'https://github.com/rancherfederal/carbide-docs/edit/main/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
'https://github.com/rancherfederal/carbide-docs/edit/main/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
Expand All @@ -63,8 +63,8 @@ const config = {
],

themeConfig:


/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
colorMode: {
Expand All @@ -90,7 +90,7 @@ const config = {
// {to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/rancherfederal/carbide-docs/issues',
label: 'Feedback',
label: 'Submit Feedback',
position: 'right',
},
],
Expand All @@ -102,43 +102,59 @@ const config = {
title: 'Docs',
items: [
{
label: 'Tutorial',
label: 'Carbide Docs',
to: '/docs/intro',
},
{
label: 'Registry',
to: '/docs/registry-docs/introduction',
},
{
label: 'STIGATRON',
to: '/docs/stigatron-docs/introduction',
},
{
label: 'Airgapped Docs',
to: '/docs/airgapped-docs/introduction',
},
],
},
{
title: 'Community',
items: [
{
label: 'ZenDesk',
href: 'https://support.rancherfederal.com',
label: 'Rancher',
href: 'https://rancher.com',
},
{
label: 'Slack',
href: 'https://rancher-users.slack.com',
label: 'Rancher GitHub',
href: 'https://github.com/rancher',
},
{
label: 'Rancher',
href: 'https://rancher.com',
label: 'Rancher Slack',
href: 'https://rancher-users.slack.com',
},
],
},
{
title: 'More',
title: 'Contact',
items: [
{
label: 'Blog',
to: '/blog',
label: 'RGS Blog',
to: 'https://ranchergovernment.com/blog',
},
{
label: 'GitHub',
label: 'RGS GitHub',
href: 'https://github.com/rancherfederal',
},
{
label: 'RGS ZenDesk',
href: 'https://support.rancherfederal.com',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Rancher Federal Inc.`,
copyright: `Copyright © ${new Date().getFullYear()} Rancher Federal, Inc. All rights reserved.`,
},
prism: {
theme: lightCodeTheme,
Expand Down

0 comments on commit ba003c6

Please sign in to comment.