Skip to content

Commit

Permalink
docs(*): update links to demo/docs site (#185)
Browse files Browse the repository at this point in the history
* docs(*): update links to demo/docs site

* docs(readme): add link to docs/demo site

* docs(readme): add docs repository link/details
  • Loading branch information
thompsonsj authored Jan 21, 2025
1 parent 41811e2 commit 1bc27c8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# slate-serializers

Docs/Demo: [https://thompsonsj.github.io/slate-serializers-demo](https://thompsonsj.github.io/slate-serializers-demo).

A collection of serializers to convert [Slate](https://www.npmjs.com/package/slate) JSON objects to various formats and vice versa. Designed to work in both Node.js and browser environments.

## Convert Slate to DOM
Expand Down Expand Up @@ -28,3 +30,4 @@ A collection of serializers to convert [Slate](https://www.npmjs.com/package/sla
- For engineering decisions, see [Engineering](https://github.com/thompsonsj/slate-serializers/blob/main/docs/engineering.md).
- Review generated NX documentation at [NX](https://github.com/thompsonsj/slate-serializers/blob/main/docs/nx.md).
- This repository is an NX monorepo. Review the docs at [https://nx.dev/](https://nx.dev/).
- Related repository: https://github.com/thompsonsj/slate-serializers-demo. [Demo/docs site](https://thompsonsj.github.io/slate-serializers-demo). Not included in this monorepo to replicate repositories that use these libraries more effectively.
2 changes: 1 addition & 1 deletion packages/html/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Convert [Slate](https://www.npmjs.com/package/slate) JSON objects to HTML and vice versa.

View the demo at [https://thompsonsj.github.io/slate-serializers-demo](https://thompsonsj.github.io/slate-serializers-demo).
View demos and documentation at [https://thompsonsj.github.io/slate-serializers-demo](https://thompsonsj.github.io/slate-serializers-demo).

## Table of contents

Expand Down

0 comments on commit 1bc27c8

Please sign in to comment.