forked from madara-alliance/bonsai-trie
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from massalabs/technical_spec
Technical spec
- Loading branch information
Showing
7 changed files
with
2,161 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
documentation/node_modules | ||
documentation/*.svg | ||
documentation/*.html | ||
documentation/*.pdf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.center-image img { | ||
display:block; | ||
margin: 0 auto; | ||
} |
Oops, something went wrong.