acid-info
/
nomos.tech
mirror of https://github.com/acid-info/nomos.tech.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
107 Commits 6 Branches 0 Tags 76 MiB
MDX 57.6%
JavaScript 30.3%
SCSS 10.3%
Shell 1.2%
TypeScript 0.6%
Go to file
Alvatar 20b24d8ecc Update index.mdx 2024-05-08 23:12:19 +09:00
.github docs: add issue and PR templates 2023-09-27 23:40:37 +09:00
.husky implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
about Update index.md 2024-02-03 08:51:41 +09:00
root-pages docs: update privacy policy 2024-04-17 02:12:00 +09:00
src Update index.mdx 2024-05-08 23:12:19 +09:00
static chore: upgrade preset version 2024-03-22 21:03:07 +09:00
.gitignore adds join us page 2023-11-16 14:34:34 +00:00
.prettierignore implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
.prettierrc implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
Jenkinsfile ci: fix negative conditional for devel deployment 2023-06-23 11:48:09 +02:00
README.md docs: update README 2023-09-06 00:28:22 +09:00
babel.config.js implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
docusaurus.config.js chore: add blog to landing page 2024-03-12 03:19:27 +09:00
package.json chore: upgrade preset 2024-04-09 18:16:46 +03:00
tsconfig.json implement nomos with docusaurus 2023-06-01 19:15:53 +09:00
yarn.lock chore: upgrade preset 2024-04-09 18:16:46 +03:00

README.md

Nomos.tech

The repository for nomos.tech website.

How to Run Locally

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

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 package.

Adding Subpages

To include subpages, create a .md or mdx file within the about directory. You can use Frontmatter 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

Subpages that do not belong to the About page (e.g., Terms of Use) can be situated in the root-pages directory.

Docusaurus Config

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.

Custom CSS

By default, this template utilizes the CSS styles defined in the logos-docusaurus-plugins 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:
$ yarn build

The static files will be created in the build directory.

  1. Serve the static build:
$ yarn serve

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.