Clone this repository
$ git clone https://github.com/acid-info/logos-brand-guidelines.git
Install the dependencies:
$ yarn install
Start the website:
$ yarn start
Visit http://localhost:3000
in your browser
Edit the docusaurus.config.js
file in the repository's root directory, and update the value of the businessUnit
field in presets section; below is a list of valid values:
Example:
presets: [
[
'@acid-info/logos-docusaurus-preset',
{
businessUnit: 'Codex',
},
],
],
This is typically sufficient for most cases, as the Logos plugins will automatically populate other configurations related to the specified business unit. If you encounter any errors in the information provided by Logos Plugins, please visit the Logos Docusaurus Plugins repository and open an issue.
This template does not include a landing page. Please review the routeBasePath: '/'
setting in the docusaurus.config.js
file.
presets: [
[
'@acid-info/logos-docusaurus-preset',
/** @type {import('@acid-info/logos-docusaurus-preset').PluginOptions} */
({
businessUnit: 'Codex',
theme: {
name: 'default',
options: {
customCss: [require.resolve('./src/css/custom.scss')],
docs: {
default: {
sidebar: {
hide: false,
},
},
},
},
},
docs: {
routeBasePath: '/', // the index.md becomes the index page
},
og: {},
}),
]
]
The content in docs/index.md
will serve as the root page for your documentation.
For additional customization options, please refer to the Docusaurus Configuration.
To add a document, create a .md
or mdx
file within the docs
directory. You can use Frontmatter to add metadata to your markdown file.
You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the Docusaurus website.
Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the Logos Docusaurus Theme repository.
By default, this template utilizes the CSS styles defined in the logos-docusaurus-plugins package. You have the option to define custom CSS in src/css/custom.scss
.
$ yarn build
The static files will be created in the build
directory.
$ yarn serve
master
and pushes to deploy-master
branch, which is hosted at https://guide.logos.co//.develop
and pushes to deploy-develop
branch, which is hosted at https://dev-guide.logos.co//.The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.
Information about deployed build can be also found in /build.json
available on the website.
develop
: git checkout develop; git checkout -b my-changes
.origin
, and open a Pull Request against the develop
branch.master
branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push
.