⚠️ 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/
.
Documentation for the Aztec Network, built with docusaurus
You can view the latest successful build here: https://docs.aztec.network
.gitignore
- This specifies which files Git should ignore when committing and pushing to remote repositories.docusaurus.config.js
- This is the configuration file for Docusaurus. You can manage the links in the header and footer, and site metadata here. A more in-depth introduction to this configuration file is available on the Docusaurus website and full documentation for the API is here.package.json
- This specifies the dependencies for the website and the commands that you can run with yarn.sidebars.js
- This specifies the sidebars for your documentation. The full documentation for this file is available on the Docusaurus website.yarn.lock
- This specifies the full dependencies for the website including the dependencies of the dependencies listed in package.json
. Do not edit this file directly. Edit package.json
instead, then run yarn
as described above.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.
We welcome contributions from the community. Please review our contribution guidelines for more information.
This website is built using Docusaurus 2, a modern static website generator.
$ yarn
To build; serve to localhost:3000
; and watch for changes:
$ yarn start:dev:local
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.
$ 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.
#include_code
You can embed code snippets into a .md
/.mdx
file from code which lives elsewhere in the repo.
#include_code identifier path/from/repo/root/to/file.ts language
#include_code hello path/from/repo/root/to/file.ts typescript
some code
some code
// docs:start:hello
more code
more code
// this-will-error <-- you can use docusaurus highlighting comments.
this code will be highlighted red
more code
// highlight-next-line
this line will be highlighted
more code
// highlight-start
this line will be highlighted
this line will be highlighted
// highlight-end
more code
// docs:end:hello
more code
some code
some code
// docs:start:hello:goodbye
this code will appear in the 'hello' snippet and the 'goodbye' snippet.
this code will appear in the 'hello' snippet and the 'goodbye' snippet.
// this-will-error
this code will be highlighted red in all snippets.
// highlight-next-line:goodbye
this line will be highlighted only in the 'goodbye' snippet.
// highlight-start:goodbye:hello
this line will be highlighted in both the `hello` and `goodbye` snippets
this line will be highlighted in both the `hello` and `goodbye` snippets
// highlight-end:goodbye
this line will be highlighted only in the 'hello' snippet.
// highlight-end:hello
this code will appear in the 'hello' snippet and the 'goodbye' snippet.
// docs:end:goodbye
this code will appear only in the 'hello' snippet.
// docs:end:hello
some code
some code
#include_code hello path/from/repo/root/to/file.ts typescript
#include_code goodbye path/from/repo/root/to/file.ts typescript
#include_code hello path/from/repo/root/to/file.ts typescript noTitle,noLineNumbers,noSourceLink
#include_code
macro!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()}</>