Getting Started

Installing Doxa

Since Doxa is a private repository and npm package, installing Doxa as a dependency requires a Github Private Access Token (classic), and an NPM account.

Steps:

  1. Create a Github Private Access token. Make sure your token has permissions to read and write packages and repo access. Make sure to save your token somewhere you can access it.
  2. Create an account with NPM.
  3. In the terminal of your project, login to to NPM using the following command:
    npm login --scope=@atria-digital-marketing --auth-type=legacy --registry=https://npm.pkg.github.com
  4. When prompted for your password, use your Private Access Token
  5. Now run npm install @atria-digital-marketing/doxa

Using Doxa

Doxa ships with both compiled and minified css along with sass.

The path to the minified css: node_modules/@atria-digital-marketing/doxa/css/doxa.min.css

The path to the main sass file: node_modules/@atria-digital-marketing/doxa/scss/_index.scss

*Note if you are using sass @use syntax, you can just point to the folder: node_modules/@atria-digital-marketing/doxa/scss

Developing on Doxa locally

To develop on the Doxa framework, clone this repo and run npm install. Then you should be able to run npm run dev which will spin up the Vitepress instance and start running sass.

Building with Doxa

When deploying a package that uses doxa through GitHub Actions, you will need to do the following:

  1. Place your PAT in a secret. This can be repository-level or organization-level, but should never be placed in your YAML in plain text
  2. Your actions/setup-node step should look like this: steps: - uses: actions/checkout@v4 - name: Set up Node.js version uses: actions/setup-node@v4 with: node-version: '20.x' cache: "npm" registry-url: "https://npm.pkg.github.com" env: NODE_AUTH_TOKEN: ${ secrets.YOUR_PAT_HERE }
  3. Finally, in the same job, make sure to provide your PAT to your installation step: - name: Install dependencies run: npm ci env: NODE_AUTH_TOKEN: ${ secrets.YOUR_PAT_HERE }

If your workflow has more than one Node setup/install combination, you will need to repeat this process.

Deploying Doxa Docs

To deploy this documentation using VitePress, refer to the official VitePress documentation for information on setting up your .yaml file.

In your app_build_command run npm run build-doxa and npm run docs:build sequentially.