This repository contains the source for vac.dev.
To publish in the blog, create a .md
or mdx
file within the rlog
directory.
Please follow sembr in the .md
or .mdx
file.
You can use Frontmatter to add metadata to your markdown file.
master
and pushes to deploy-master
branch, which is hosted at https://vac.dev//.develop
and pushes to deploy-develop
branch, which is hosted at https://dev.vac.dev//.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
.Clone this repository
$ git clone https://github.com/acid-info/logos-blog-template.git
Install the dependencies:
$ yarn install
Start the website:
$ yarn start
Visit http://localhost:3000/
in your browser
Note: The following contains options that go beyond what is needed to add new blog posts. To simply add a blog post, follow the steps listed above.
The blog utilizes the Docusaurus blog plugin configured in docusaurus.config.js
.
[
'@docusaurus/plugin-content-blog',
/** @type {import('@docusaurus/plugin-content-blog').PluginOptions} */
({
id: 'blog',
routeBasePath: '/',
path: 'posts',
blogTitle: 'Research Log',
blogSidebarCount: 0,
authorsMapPath: 'authors.yml',
remarkPlugins: [math],
rehypePlugins: [katex],
}),
]
A list of authors can be defined in /posts/authors.yml
.
For additional customization options, please refer to the Docusaurus Blog Plugin documentation.
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.
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.