acid-info
/
logos-docusaurus-plugins
mirror of https://github.com/acid-info/logos-docusaurus-plugins.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
logos-docusaurus-plugins/README.md

4.9 KiB
Raw Permalink Blame History

Overview

This repository contains a set of Docusaurus 2 plugins and themes, initially crafted for Logos websites but versatile enough for use with any Docusaurus website. The collection includes a headless local search, OG image generation, and Fathom Analytics plugins.

Quick start

Use a template

Kickstart your website creation with our ready-to-use templates. Choose a template that fits your needs, whether it's a documentation, a blog, or a complete website.

  1. Choose a template:
  1. Clone your selected template:
# Example: Create a website with a landing page
git clone https://github.com/acid-info/logos-homepage-template.git my-website && cd my-website

# Example: Create a documentation website
git clone https://github.com/acid-info/logos-documentation-website-template.git my-website && cd my-website

# Example: create a blog
git clone https://github.com/acid-info/logos-blog-template.git my-website && cd my-website
  1. Install the dependencies:
yarn install
  1. Run your new website locally:
yarn start

Use with an existing Docusaurus website:

  1. Install the Logos Docusaurus preset:
yarn add @acid-info/logos-docusaurus-preset
  1. Add the preset to your docusaurus.config.js:
presets: [
    [
      '@acid-info/logos-docusaurus-preset',
      /** @type {import('@acid-info/logos-docusaurus-preset').PluginOptions} */
      ({
        businessUnit: 'Logos',
      }),
    ],
  ],

Use the playground

A playground located in the packages/docusaurus-playground of this repository can be used to test the plugins and themes locally.

  1. Clone the repository:
git clone https://github.com/acid-info/logos-docusaurus-plugins.git
  1. Install the dependencies:
yarn install && yarn link
  1. Run the playground:
yarn start

Next steps

Working on content

Our plugins work smoothly with standard Docusaurus features, which you can use to manage and organize content. Learn more on the Docusaurus website. For practical guidance on dealing with common use cases, visit our dedicated Wiki pages.

Configuration

While it's possible to install and configure our plugins and themes individually, we highly recommend using the Logos Docusaurus preset for a simplified installation. This preset establishes a default configuration for the plugins and theme and automatically incorporates essential website metadata, logos, and favicons for the selected business unit. For detailed configuration information, please refer to the README file of each package.

Become a contributor

We welcome any kind of contribution, such as reporting issues, suggesting features, writing documentation or fixing bugs. Please read our contributing guidelines on how to get started.

Packages