-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
3,923 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,137 @@ | ||
| - [Description](#description) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Development Guides](#development-guides) | ||
| - [Run locally](#run-locally) | ||
| - [Versioning](#versioning) | ||
| - [Overview](#overview) | ||
| - [Quick start](#quick-start) | ||
| - [Use a template](#use-a-template) | ||
| - [Use with an existing Docusaurus website:](#use-with-an-existing-docusaurus-website) | ||
| - [Use the playground](#use-the-playground) | ||
| - [Next steps](#next-steps) | ||
| - [Working on content](#working-on-content) | ||
| - [Configuration](#configuration) | ||
| - [Become a contributor](#become-a-contributor) | ||
| - [Packages](#packages) | ||
| - [TODO](#todo) | ||
| - [License](#license) | ||
|
|
||
| # Description | ||
| ## Overview | ||
|
|
||
| This monorepo contains a set of [Docusaurus 2](https://docusaurus.io/) plugins and themes developed for Logos documentation websites. | ||
| 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. | ||
|
|
||
| # Installation | ||
| ## Quick start | ||
|
|
||
| Clone this repository and install the dependencies by running the following: | ||
| ### Use a template | ||
|
|
||
| ```bash | ||
| $ yarn | ||
| ``` | ||
| 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: | ||
|
|
||
| # Usage | ||
| - [Website Template](https://github.com/acid-info/logos-website-template) | ||
| - [Documentation Website Template](https://github.com/acid-info/logos-documentation-website-template) | ||
| - [Blog Template](https://github.com/acid-info/logos-blog-template) | ||
|
|
||
| Clone our ready-to-use [Docusaurus template](https://github.com/acid-info/logos-documentation-website-template). | ||
| 2. Clone your selected template: | ||
|
|
||
| # Development Guides | ||
| ```bash | ||
| # 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 | ||
|
|
||
| ## Run locally | ||
| # Example: create a blog | ||
| git clone https://github.com/acid-info/logos-blog-template.git my-website && cd my-website | ||
| ``` | ||
|
|
||
| To make the development easier and to remove the need to locally link an external repository to the packages in this project, we've created a playground Docusaurus website which can be found in `packages/docusaurus-playground`. | ||
| 3. Install the dependencies: | ||
|
|
||
| [Lerna](https://lerna.js.org/) will handle linking the packages; however, if you want to use them in another project, you should use tools like [yarn link](https://classic.yarnpkg.com/en/docs/cli/link) or [yalc](https://github.com/wclr/yalc); but please be careful not to commit changes made by these tools. | ||
| ```bash | ||
| yarn install | ||
| ``` | ||
|
|
||
| 1. Install dependencies and link packages together: | ||
| 4. Run your new website locally: | ||
|
|
||
| ```bash | ||
| $ yarn && yarn bootstrap | ||
| yarn start | ||
| ``` | ||
|
|
||
| 2. Build packages: | ||
| ### Use with an existing Docusaurus website: | ||
|
|
||
| 1. Install the [Logos Docusaurus preset](./packages/logos-docusaurus-preset/): | ||
|
|
||
| ```bash | ||
| $ yarn build | ||
| yarn add @acid-info/logos-docusaurus-preset | ||
| ``` | ||
|
|
||
| 2. Add the preset to your `docusaurus.config.js`: | ||
|
|
||
| # or build and watch for changes | ||
| ```js | ||
| presets: [ | ||
| [ | ||
| '@acid-info/logos-docusaurus-preset', | ||
| /** @type {import('@acid-info/logos-docusaurus-preset').PluginOptions} */ | ||
| ({ | ||
| businessUnit: 'Logos', | ||
| }), | ||
| ], | ||
| ], | ||
|
|
||
| $ yarn watch | ||
| ``` | ||
|
|
||
| 2. Start the playground website: | ||
| ### 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: | ||
|
|
||
| ```bash | ||
| $ yarn start | ||
| git clone https://github.com/acid-info/logos-docusaurus-plugins.git | ||
| ``` | ||
|
|
||
| ## Versioning | ||
| 2. Install the dependencies: | ||
|
|
||
| ```bash | ||
| yarn install && yarn link | ||
| ``` | ||
|
|
||
| We use semantic versioning; all you need to do is commit your changes and then run the following command: | ||
| 3. Run the playground: | ||
|
|
||
| ```bash | ||
| $ yarn lerna version --no-private | ||
| yarn start | ||
| ``` | ||
|
|
||
| # Packages | ||
| ## 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](https://docusaurus.io/docs). For practical guidance on dealing with common use cases, visit our dedicated [Wiki pages](https://github.com/acid-info/logos-docusaurus-plugins/wiki). | ||
|
|
||
| ### Configuration | ||
|
|
||
| While it's possible to install and configure our plugins and themes individually, we highly recommend using the [Logos Docusaurus preset](./packages/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](./CONTRIBUTING.md) on how to get started. | ||
|
|
||
| ## Packages | ||
|
|
||
| - **Presets** | ||
|
|
||
| - [Logos Preset](./packages/logos-docusaurus-preset) [](https://www.npmjs.com/package/@acid-info/logos-docusaurus-preset) | ||
| - [Logos Preset](./packages/logos-docusaurus-preset) - A Docusaurus preset for Logos websites. | ||
| [](https://www.npmjs.com/package/@acid-info/logos-docusaurus-preset) | ||
|
|
||
| - **Plugins** | ||
|
|
||
| - [Logos Search Local](./packages/logos-docusaurus-search-local) [](https://www.npmjs.com/package/@acid-info/logos-docusaurus-search-local) | ||
| - [Logos Search Local](./packages/logos-docusaurus-search-local) - Headless local search engine for Docusaurus. | ||
| [](https://www.npmjs.com/package/@acid-info/logos-docusaurus-search-local) | ||
|
|
||
| - [Docusaurus OG](./packages/docusaurus-og) [](https://www.npmjs.com/package/@acid-info/docusaurus-og) | ||
| - [Docusaurus OG](./packages/docusaurus-og) - OpenGraph image generator for Docusaurus. | ||
| [](https://www.npmjs.com/package/@acid-info/docusaurus-og) | ||
|
|
||
| - [Docusaurus Fathom](./packages/docusaurus-fathom) [](https://www.npmjs.com/package/@acid-info/docusaurus-fathom) | ||
| - [Docusaurus Fathom](./packages/docusaurus-fathom) - Fathom Analytics plugin for Docusaurus. | ||
| [](https://www.npmjs.com/package/@acid-info/docusaurus-fathom) | ||
|
|
||
| - **Themes** | ||
| - [Logos Theme](./packages/logos-docusaurus-theme) [](https://www.npmjs.com/package/@acid-info/logos-docusaurus-theme) | ||
| - [Logos Theme](./packages/logos-docusaurus-theme) - A customized version of Docusaurus classic theme built with [LSD](https://github.com/acid-info/lsd). | ||
| [](https://www.npmjs.com/package/@acid-info/logos-docusaurus-theme) | ||
|
|
||
| ## License | ||
|
|
||
| TODO |
Oops, something went wrong.