AztecProtocol / docs

Aztec docs site
MIT License
8 stars 37 forks source link

⚠️ This repository is now archived. ⚠️

To update the docs at https://docs.aztec.network, please submite a pull request to the aztec-packages repo here. The docs live in ./docs/.

Aztec Network Documentation

Documentation for the Aztec Network, built with docusaurus

You can view the latest successful build here: https://docs.aztec.network

Files

The .md files in the docs/ directory are the docs. See the Docusaurus website for the full documentation on how to create docs and to manage the metadata.

Contributing

We welcome contributions from the community. Please review our contribution guidelines for more information.

Docusaurus

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Development

Locally

To build; serve to localhost:3000; and watch for changes:

$ yarn start:dev:local

Remotely (on mainframe)

To build; serve to localhost:3000; and watch for changes:

$ yarn start:dev

This command preprocesses #include_code macros, then builds the html, then starts a local development server and opens up a browser window (at localhost:3000, by default). Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service. When run on Netlify, it will also build the typescript projects needed for extracting type information via typedoc.

Macros

#include_code

You can embed code snippets into a .md/.mdx file from code which lives elsewhere in the repo.

See here for another way to include code, although this approach is flakier, so the above #include_code macro is preferred.

#include_aztec_version

This macros will be replaced inline with the current aztec packages tag, which is aztec-packages-v0.7.10 at the time of these writing. This value is sourced from .release-please-manifest.json on the project root.

Alternatively, you can also use the AztecPackagesVersion() js function, which you need to import explicitly:

import { AztecPackagesVersion } from "@site/src/components/Version";
<>{AztecPackagesVersion()}</>

#include_noir_version

This macros will be replaced inline with the required nargo version, which is 0.11.1-aztec.0 at the time of these writing. This value is sourced from yarn-project/noir-compiler/src/noir-version.json.

Alternatively, you can also use the NoirVersion() js function, which you need to import explicitly:

import { NoirVersion } from "@site/src/components/Version";
<>{NoirVersion()}</>