Skip to content

Commit

Permalink
Merge pull request #1 from massalabs/technical_spec
Browse files Browse the repository at this point in the history
Technical spec
  • Loading branch information
AurelienFT authored Nov 16, 2023
2 parents 220d115 + bc71060 commit c400897
Show file tree
Hide file tree
Showing 7 changed files with 2,161 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
documentation/node_modules
documentation/*.svg
documentation/*.html
documentation/*.pdf
27 changes: 27 additions & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Project Documentation

This project's documentation is generated using [asciidoctor-web-pdf](https://github.com/ggrossetie/asciidoctor-web-pdf), a tool that converts AsciiDoc content to a styled PDF using web technologies.

## Prerequisites

Ensure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed on your machine.

## Setup

1. **Install Dependencies**:

Before generating the documentation, you need to install the necessary dependencies. Navigate to the project directory and run:

```shell
npm install
```

2. **Generate Documentation**:

Once the dependencies are installed, you can generate the documentation using the provided script:

```shell
npm run generate-doc
```

After executing the script, the generated documentation will be available in the specified output directory.
4 changes: 4 additions & 0 deletions documentation/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.center-image img {
display:block;
margin: 0 auto;
}
Loading

0 comments on commit c400897

Please sign in to comment.