Skip to content

Commit dd016fb

Browse files
author
Hugues Tennier
authored
Merge pull request #482 from thomvaill/log4brains
Add Log4brains to generators
2 parents 7b7898f + b918977 commit dd016fb

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

src/site/generators/log4brains.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Log4brains
3+
repo: thomvaill/log4brains
4+
homepage: https://github.com/thomvaill/log4brains
5+
language:
6+
- JavaScript
7+
license:
8+
- Apache-2.0
9+
templates:
10+
- Markdown
11+
description: Docs-as-code knowledge base to manage Architecture Decision Records (ADR) for your project and publish them automatically as a static website
12+
---
13+
14+
Log4brains is a docs-as-code knowledge base for your development and infrastructure projects.
15+
It enables you to write and manage [Architecture Decision Records](https://adr.github.io/) (ADR) right from your IDE, and to publish them automatically as a static website.
16+
17+
It performs Static Site Generation from markdown files thanks to [Next.js](https://jamstack.org/generators/next/).
18+
19+
## Install
20+
21+
From your project's root directory:
22+
23+
```sh
24+
npx init-log4brains
25+
```
26+
27+
## Local preview
28+
29+
```sh
30+
npm run log4brains-preview
31+
```
32+
33+
## Build and deploy
34+
35+
```sh
36+
npm run log4brains-build
37+
```
38+
39+
See [Log4brains documentation](https://thomvaill.github.io/log4brains/adr/) for more information.
40+
41+
## Example
42+
43+
[Log4brains' own architecture knowledge base](https://thomvaill.github.io/log4brains/adr/)

0 commit comments

Comments
 (0)