Skip to content

Commit

Permalink
Port the documentation to Docsify
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Apr 9, 2023
1 parent 97ce13e commit bb3d8f7
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 4 deletions.
Empty file added docs/.nojekyll
Empty file.
19 changes: 19 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# MC2IT Card
Business card of MC2IT, distribution and services, implemented in [Haxe](https://haxe.org).

## Usage
Before you start, you need to make sure you have [Node.js](https://nodejs.org) up and running.
You can verify if you're already good to go with the following command:

```shell
node --version
# v19.0.0
```

Then, to display the business card, just type the following command in your terminal:

```shell
npx @mc2it/card
```

And voila!
2 changes: 2 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [License](license.md)
- [See also](see_also.md)
20 changes: 20 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# MIT License
Copyright © 2022-2023 MC2IT

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 5 additions & 0 deletions docs/see_also.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# See also
- [API reference](https://mc2it.github.io/card/api)
- [Git repository](https://github.com/mc2it/card)
- [npm package](https://www.npmjs.com/package/@mc2it/card)
- [Submit an issue](https://github.com/mc2it/card/issues)
8 changes: 4 additions & 4 deletions scripts/Doc.hx
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ import sys.io.File;

/** Builds the documentation. **/
function main() {
if (FileSystem.exists("docs")) Tools.removeDirectory("docs");
if (FileSystem.exists("docs/api")) Tools.removeDirectory("docs/api");

Sys.command("haxe --define doc-gen --no-output --xml var/api.xml build.hxml");
Sys.command("lix", ["run", "dox",
"--define", "description", "Business card of MC2IT, distribution and services.",
"--define", "source-path", "https://github.com/mc2it/card/blob/main/src",
"--define", "themeColor", "0x165898",
"--define", "version", Version.packageVersion,
"--define", "website", "https://github.com/mc2it/card",
"--define", "website", "https://mc2it.github.io/card",
"--input-path", "var",
"--output-path", "docs",
"--output-path", "docs/api",
"--title", "MC2IT Card",
"--toplevel-package", "mc2it_card"
]);

File.copy("www/favicon.ico", "docs/favicon.ico");
File.copy("docs/favicon.ico", "docs/api/favicon.ico");
}

0 comments on commit bb3d8f7

Please sign in to comment.