acid-info
/
acid.info
mirror of https://github.com/acid-info/acid.info.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Acid Info website repo https://acid.info
95 Commits 7 Branches 0 Tags 136 MiB
JavaScript 62%
SCSS 18.3%
MDX 18.2%
TypeScript 1.5%
Go to file
jinhojang6 6240fd00f6
chore: upgrade preset version 		2024-04-29 23:27:09 +09:00
.github feat: add issue and pull request templates 2023-11-10 00:30:56 +09:00
docs Update index.md for testing purposes 2023-11-29 23:49:14 +09:00
root-pages chore: update content 2023-11-02 01:08:42 +09:00
src fix: page shifting issue 2023-07-20 00:37:57 +03:30
static feat: update landing page 2023-07-15 17:49:45 +09:00
.gitignore update .gitignore 2023-06-09 05:43:21 +03:30
Jenkinsfile fix jenkinsfile 2023-06-07 22:01:25 +01:00
README.md docs: update README 2023-09-06 00:15:45 +09:00
babel.config.js upgrade to v1 2023-06-06 15:14:30 +02:00
docusaurus.config.js style: use system theme by default 2023-11-28 22:44:05 +09:00
package.json chore: upgrade preset version 2024-04-29 23:27:09 +09:00
sidebars.js upgrade to v1 2023-06-06 15:14:30 +02:00
tsconfig.json upgrade to v1 2023-06-06 15:14:30 +02:00
yarn.lock chore: upgrade preset version 2024-04-29 23:27:09 +09:00

README.md

Acid.info

The repository for acid.info website.

How to Run Locally

  1. Clone this repository
$ git clone https://github.com/acid-info/acid.info.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.