acid-info
/
logos-homepage-template
mirror of https://github.com/acid-info/logos-homepage-template.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update README

This commit is contained in:
jinhojang6 2023-09-05 23:56:12 +09:00
parent 6742cd4467
commit 586c3ff33e
1 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -3,7 +3,7 @@
The template repository for homepage using [logos-docusaurus-plugins](https://github.com/acid-info/logos-docusaurus-plugins).
## Use cases
## Use Cases
- [nomos.tech](https://nomos.tech/)
- [waku.org](https://waku.org/)
- [nomos.tech](https://nomos.tech/)
@ -55,30 +55,52 @@ presets: [
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](https://github.com/acid-info/logos-docusaurus-plugins) repository and open an issue.
## Landing page
## Landing Page
The code for a landing page is located in `src/pages/index.mdx`. This file employs the `mdx` format and utilizes React components from the [Logos Docusaurus Plugins](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/src/client/components/mdx) package.
## Adding subpages
## Adding Subpages
To include subpages (e.g., https://nomos.tech/about/architect), create a `.md` or `mdx` file within the `about` directory. You can use [Frontmatter](https://docusaurus.io/docs/markdown-features#front-matter) to add metadata to your markdown file.
The content in `about/index.md` will be utilized as the index page for the `/about` section.
## Root pages
## Root Pages
Subpages that do not belong to the `About` page (e.g., [Terms of Use](https://nomos.tech/terms)) can be situated in the `root-pages` directory.
## Customization
## Docusaurus Config
You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the [Docusaurus](https://docusaurus.io/docs) website.
> Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/) repository.
## Custom CSS
By default, this template utilizes the CSS styles defined in the [logos-docusaurus-plugins](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/src/client/css) package. You have the option to define custom CSS in `src/css/custom.scss`.
## How to Run a Static Build (Production Build)
1. Generate static files for production:
```bash
$ yarn build
```
The static files will be created in the `build` directory.
2. Serve the static build:
```bash
$ yarn serve
```
## CI/CD
- The `master` branch is automatically deployed to the production server (e.g., logos.co) through [CI](https://ci.infra.status.im)