codex-storage
/
codex.storage
mirror of https://github.com/codex-storage/codex.storage.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
135 Commits 10 Branches 0 Tags 170 MiB
MDX 89.8%
JavaScript 4.1%
TypeScript 3.5%
SCSS 2.5%
Shell 0.1%
Go to file
Lazar Jaksic 7220953e6d Update faq.mdx 
Added the proposed updates to the FAQ section based on Agata's comments.
 		2024-01-10 21:08:38 +09:00
.github docs: add issue and PR templates 2023-09-27 23:38:09 +09:00
.husky feat: upgrade logos preste && replace hero model with a pre-rendered video 2023-07-04 18:44:21 +03:30
about Update faq.mdx 2024-01-10 21:08:38 +09:00
root-pages Update news.md 2024-01-02 14:45:50 -05:00
src chore: upgrade @acid-info/logos-docusaurus-preset 2023-12-20 15:19:06 +03:30
static Merge branch 'master' into develop 2023-12-12 19:37:00 -05:00
.gitignore adds join us page 2023-11-16 17:55:18 +00:00
.prettierignore Initial commit 2022-10-31 14:59:47 +03:30
.prettierrc Initial commit 2022-10-31 14:59:47 +03:30
Jenkinsfile add Jenkinsfile 2023-06-01 21:55:38 +01:00
README.md docs: update README 2023-09-06 00:27:43 +09:00
babel.config.js Initial commit 2022-10-31 14:59:47 +03:30
docusaurus.config.js chore: add news to navbar 2024-01-02 15:06:19 -05:00
package.json chore: upgrade @acid-info/logos-docusaurus-preset 2023-12-20 15:19:06 +03:30
tsconfig.json Initial commit 2022-10-31 14:59:47 +03:30
yarn.lock chore: upgrade @acid-info/logos-docusaurus-preset 2023-12-20 15:19:06 +03:30

README.md

Codex.storage

The repository for codex.storage website.

How to Run Locally

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