JokeAPI is a RESTful API that serves uniformly and well formatted jokes.
This is its homepage, powered by Docusaurus.
View the live page at v3.jokeapi.dev
Please refer to the contributing guide for information on how to contribute to this project.
- Install Node.js LTS or Current
- Clone the repository
- Install the dependencies with
npm i - Refer to CLI commands
| Command | Description |
|---|---|
npm run start |
Builds the page and serves it locally. Rebuilds and hot-reloads it automatically when code changes. |
npm run lint |
Runs ESLint to find any errors and bad formatting. |
npm run storybook |
Runs Storybook for creating and testing components without the overhead of the rest of the website. |
npm run build |
Builds the static page into the build folder for deployment. |
npm run write-translations |
Extracts the translatable strings into JSON files in the i18n folder. |
npm run write-heading-ids |
Generates heading IDs in markdown files. |
npm run clear |
Deletes the cache and generated files of Docusaurus. |
npm run swizzle @docusaurus/theme-classic <component_name> |
Generates a swizzled component, i.e. allows for modifying components that are part of the preset theme. |
npm run docusaurus -- <command> |
Runs any Docusaurus CLI command |
npm run serve |
Serves the static output of npm run build for locally testing a production deployment. |
npm run typecheck |
Uses TypeScript compiler to check for type errors. |
The homepage is licensed under the MIT License
Made with ❤️ by Sv443
Please consider supporting the development