Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 3.41 KB

README.md

File metadata and controls

105 lines (76 loc) · 3.41 KB
Raw

This repository contains the source for vac.dev.

Vac Research Blog

Adding posts

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.

CI/CD

  • The master branch is automatically deployed to the production server (e.g., logos.co) through CI
  • The develop branch is automatically deployed to the staging server (e.g., dev.logos.co) through CI

Change Process

  1. Create a new working branch from develop: git checkout develop; git checkout -b my-changes.
  2. Make your changes, push them to the origin, and open a Pull Request against the develop branch.
  3. After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
  4. When ready to promote changes to the live website, rebase the master branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push.

How to Run Locally

  1. Clone this repository
$ git clone https://github.com/acid-info/logos-blog-template.git
  1. Install the dependencies:
$ yarn install
  1. Start the website:
$ yarn start
  1. Visit http://localhost:3000/ in your browser

Further Info and Configuration

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.

Blog Setup

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.

Customization

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.

Configuration

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:

  • Logos
  • Codex
  • Waku
  • Nimbus
  • Nomos
  • VacResearch
  • Acid.info

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.