This repository has been archived by the owner on Mar 10, 2023. It is now read-only.

atlassian-archive / brisk-docs Public archive

Notifications You must be signed in to change notification settings
Fork 6
Star 16

Home for brisk-docs packages - developed by Atlassian

brisk-docs.netlify.com/

MIT license

16 stars 6 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 186 Commits
.changeset		.changeset
.circleci		.circleci
.github/workflows		.github/workflows
__mocks__		__mocks__
deploy		deploy
docs		docs
example-pages		example-pages
packages		packages
scripts		scripts
typings		typings
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierignore		.prettierignore
.prettierrc		.prettierrc
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
babel.config.js		babel.config.js
cypress.json		cypress.json
docs.config.js		docs.config.js
jest-setup.js		jest-setup.js
jest.config.js		jest.config.js
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Repository files navigation

Brisk Docs

Tools to document your mono-repos and React Packages

Brisk is an Atlassian Initiative to help with documenting code. It contains two main parts:

The Brisk Website Generator

This is packaged as @brisk-docs/website and is designed as an all-inclusive documentation tool for mono-repos containing react components and other packages. Check out the package's documentation for more information on how to use it.

Support Packages

As part of being maximally useful, we want to make sure where possible, our helper components exist as their own packages. As such, there are a number of other libraries we maintain that you might be interested in, even if you don't need the complete set of things that brisk does: