The repository for develp.co website.
- Clone this repository
$ git clone https://github.com/acid-info/develp.co.git
- Install the dependencies:
$ yarn install
- Start the website:
$ yarn start
- Visit
http://localhost:3000
in your browser
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.
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.
Subpages that do not belong to the About
page (e.g., Terms of Use) can be situated in the root-pages
directory.
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.
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
.
- Generate static files for production:
$ yarn build
The static files will be created in the build
directory.
- Serve the static build:
$ yarn serve
- The
master
branch is deployed to https://develp.co/ through Jenkins CI. - The
develop
branch is deployed to https://dev.develp.co/ through Jenkins CI.
- Create a new working branch from
develop
:git checkout develop; git checkout -b my-changes
. - Make your changes, push them to the
origin
, and open a Pull Request against thedevelop
branch. - After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
- 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
.