mirror of https://github.com/teamhanko/hanko.git synced 2025-10-27 14:17:56 +08:00

Files

dependabot[bot] 4dbcc63cdf chore(deps): bump json5 from 2.2.1 to 2.2.3 in /docs

Bumps [json5](https://github.com/json5/json5) from 2.2.1 to 2.2.3.
- [Release notes](https://github.com/json5/json5/releases)
- [Changelog](https://github.com/json5/json5/blob/main/CHANGELOG.md)
- [Commits](https://github.com/json5/json5/compare/v2.2.1...v2.2.3)

---
updated-dependencies:
- dependency-name: json5
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

2023-01-09 06:37:18 +00:00

docs

minor text changes

2022-12-16 16:54:25 +01:00

src

feat(examples): add svelte example

2022-12-05 16:14:00 +01:00

static

feat(examples): add svelte example

2022-12-05 16:14:00 +01:00

.gitignore

docs: move documentation into monorepo

2022-09-12 13:15:42 +02:00

babel.config.js

docs: move documentation into monorepo

2022-09-12 13:15:42 +02:00

docusaurus.config.js

docs: remove announcement bar

2022-11-24 10:41:00 +01:00

LICENSE

docs: move documentation into monorepo

2022-09-12 13:15:42 +02:00

package-lock.json

chore(deps): bump json5 from 2.2.1 to 2.2.3 in /docs

2023-01-09 06:37:18 +00:00

package.json

docs: add hint to hanko cloud in intro and api url info in frontend guides

2022-11-24 15:20:47 +01:00

README.md

docs: move documentation into monorepo

2022-09-12 13:15:42 +02:00

sidebars.js

docs: add a simple guide for mobile

2022-12-16 12:07:50 +01:00

tsconfig.json

docs: move documentation into monorepo

2022-09-12 13:15:42 +02:00

README.md

Hanko Documentation

The Hanko documentation is built using Docusaurus 2, a modern static website generator.

Installation

$ npm install

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Swizzled components

The following components have been swizzled:

`DocCard`

Make icons used in the DocCard customizable via sidebar_custom_props
Make description toggle-able via sidebar_custom_props

Uses the following sidebar_custom_props:

Name	Type	Default	Description
docCardIconName	string	undefined	Name of the icon file without file extension. Icons must be placed in `static/img/icons` folder and have an *.svg extension. Uses default images if `undefined`.
docCardShowDescription	boolean	undefined/false	Whether to show the description in auto-generated link/category cards. Introduced for SEO reasons such that front-matter `description`s can be used to generate meta tags without being forced to display them in the DocCard.