Skip to content

Commit

Permalink
Update the API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Jan 22, 2024
1 parent 572500d commit 74532e5
Show file tree
Hide file tree
Showing 37 changed files with 1,525 additions and 11,110 deletions.
13 changes: 7 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# MC2IT Card
Business card of MC2IT, distribution and services, implemented in [TypeScript](https://www.typescriptlang.org).
# Cédric Belin's Card
Business card of Cédric Belin, yet another full stack developer,
addicted to [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript) and [PHP](https://www.php.net).

## Usage
Before you start, you need to make sure you have [Node.js](https://nodejs.org) up and running.
Expand All @@ -13,12 +14,12 @@ node --version
Then, to display the business card, just type the following command in your terminal:

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

And voila!

## See also
- [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)
- [Git repository](https://github.com/cedx/card)
- [npm package](https://www.npmjs.com/package/@cedx/card)
- [Submit an issue](https://github.com/cedx/card/issues)
1 change: 1 addition & 0 deletions docs/api/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
1 change: 0 additions & 1 deletion docs/api/404.html

This file was deleted.

22 changes: 22 additions & 0 deletions docs/api/assets/highlight.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
:root {
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}

@media (prefers-color-scheme: light) { :root {
--code-background: var(--light-code-background);
} }

@media (prefers-color-scheme: dark) { :root {
--code-background: var(--dark-code-background);
} }

:root[data-theme='light'] {
--code-background: var(--light-code-background);
}

:root[data-theme='dark'] {
--code-background: var(--dark-code-background);
}

pre, code { background: var(--code-background); }
59 changes: 59 additions & 0 deletions docs/api/assets/main.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/api/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/api/assets/search.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 74532e5

Please sign in to comment.