Commit Graph

36 Commits

Author SHA1 Message Date
Dom H c679b7e07d fix(docs): Standardize URLs with no trailing slash
Previously, a trailing slash would be appended to all URLs when accessed
directly, but not when accessed via menus and links.

This Docusaurus configuration option keeps the URLs consistent by never
appending a trailing slash.

https://docusaurus.io/docs/api/docusaurus-config#trailing-slash
2022-05-23 10:09:53 -04:00
Peter Johanson 6501e68c2d fix(docs): Remove breadcrumbs (for now)
* Remove breadcrumbs until they're useful
  with content for each level in our docs.
2022-04-06 06:01:39 -04:00
Peter Johanson c259c7b27a fix(docs): Updated proper API key. 2022-04-06 06:01:39 -04:00
Peter Johanson 60d367cbb9 refactor(docs): Bump to docusaurus 2.0.0-beta.18
* Fix up the config to use proper locations.
2022-04-06 06:01:39 -04:00
Joel Spadin ed41d42874 feat(docs): Add aggregated metadata to website
Added /hardware-metadata.json to the ZMK website.
This gives external tools a way to grab all hardware metadata at once.
2022-03-29 23:03:56 -04:00
Peter Johanson b82bbb5ba2 feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
Peter Johanson 47abbe7925 feat(docs): Add dynamic hardware list component. 2021-09-11 00:50:36 -04:00
Peter Johanson 5e6634d2e5 feat(docs): Add TS type gen, metadata JSON gen
* Generate TS types from new hardware metadata schema.
* Aggregate all hw metadata YAML into one aggregate JSON
  file for consumption by others.
2021-09-11 00:50:36 -04:00
Peter Johanson 3f4839ec96 refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
Piotr Gnus 96bd927be2
feat(docs): Added support for prefers-color-scheme in docs
Now, instead of always defaulting to light theme, documentation, docs
will default to the color scheme based by the user preference (reported
by web browser as a `prefers-color-scheme` media query).

It is still possible for user to change the theme by using the switch
next to the search box. His preference will be remembered.
2021-05-05 00:15:38 -04:00
Nick Winans 4ef11ac4aa feat(docs): Add power profiler 2021-03-11 16:31:34 -05:00
innovaker 40694a0969 docs: remove redundant slash from "docs/" navigation item
Aligns with the blog item.

PR: #608
2021-01-30 00:02:11 -05:00
Joel Spadin 5aa8a07aa9 feat(docs): add keymap upgrader
Added a documentation page with a script that upgrades deprecated key
codes and behaviors to their replacements.

Fixes #299
2020-12-10 12:23:05 +00:00
innovaker 532c1987b2 refactor(docs): Move `dev-` documents into `/development`
Aligns to conventions introduced by newer documentation.
2020-11-20 22:31:56 -05:00
innovaker ff638eb010 docs(codes): Add (key) codes documentation
Create codes documentation for standardized keys.

Closes #218.  Fixes #308.  Ref #21.
2020-11-06 15:02:12 -05:00
Pete Johanson 571d045c75 fix(docs): Explicit CC-BY-NC-SA license for docs. 2020-10-26 23:15:48 -04:00
innovaker cd683b8dd6 chore(docs): Replace homePageId with slug: /
Fix warning ...
The docs plugin option homePageId=intro is deprecated. To make a doc the "home", prefer frontmatter: "slug: /"

Follow-up to #286.
2020-10-21 13:52:25 +01:00
Cody McGinnis c3b4525d25 Fix edit url links for the website. 2020-08-13 00:19:59 -04:00
Pete Johanson a6ef1cddec Add analytics. 2020-08-11 16:55:36 -04:00
Pete Johanson 10683fe1f8 Docs re-org, start of some keymap docs. 2020-08-06 15:04:31 -04:00
Pete Johanson 6fd572d3b6 Use `process.env.URL` instead of `DEPLOY_URL`. 2020-08-05 14:58:25 -04:00
Pete Johanson aa21bdd79a Tweak for dynamic invite URL for deploys. 2020-08-05 14:43:59 -04:00
Pete Johanson db586b1ce0 Update to latest V2 Docusaurus. 2020-08-05 14:02:37 -04:00
Pete Johanson 2d99e69eb7
Add Netlify deploy badge 2020-07-21 19:58:34 -04:00
Pete Johanson 22c0558b2f Community link fixes. 2020-07-20 23:39:19 -04:00
Pete Johanson 3cc8b96ac8 Updated link to Discord invite. 2020-07-03 10:45:50 -04:00
Pete Johanson 22238d24de Add Algolia search config. 2020-06-29 10:20:07 -04:00
Pete Johanson c96e705e2e A few more master to main fixes. 2020-06-17 10:38:15 -04:00
innovaker 82d0bd860d docs: Add "sidebarCollapsible: false" 2020-06-14 14:23:48 +01:00
Pete Johanson a952cd6899 Title fix, remove redundant "keyboard". 2020-06-09 23:24:19 -04:00
Pete Johanson e9d7c54b1c New logo and color palette. 2020-06-09 23:18:12 -04:00
Pete Johanson dbabeffa8a Properly reference MIT license consistently. 2020-06-09 09:52:26 -04:00
Pete Johanson 6b48b6dadd Initial cleanup of docs template, GitHub URLs, etc. 2020-06-08 23:10:48 -04:00
Pete Johanson 5304ff9c77 Basic ZMK logo. 2020-06-08 10:46:38 -04:00
Pete Johanson f1afbb8e49 Some basic docs clean up. 2020-05-31 15:35:32 -04:00
Pete Johanson e00408d746 Initial work on basic documentation. 2020-05-25 21:33:21 -04:00