Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(embed): add the code embed documentation #59

Merged
merged 1 commit into from
Nov 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/publish-embed.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
paths:
- 'packages/embed/src/scripts/**'
- 'packages/embed/src/styles/**'
- 'packages/embed/package.publish.json'
- 'packages/embed/README.publish.md'

jobs:
build:
Expand Down
6 changes: 3 additions & 3 deletions packages/embed/README.publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This package contains the script and style assets for code snippet rendering in an embed.

To use it, include the CSS and JavaScript link to JSDelivr file.
To use it, include the CSS and JavaScript link to [UNPKG](https://unpkg.com) file.

```html
<link rel="stylesheet" type="text/css" href="https://jsdelivr.net/npm/@snipcode/[email protected].2/style.min.css" />
<script type="text/javascript" src="https://jsdelivr.net/npm/@snipcode/[email protected].2/script.min.css"></script>
<link rel="stylesheet" type="text/css" href="https://www.unpkg.com/@snipcode/[email protected].3/style.min.css" />
<script type="text/javascript" src="https://www.unpkg.com/@snipcode/[email protected].3/script.min.js"></script>
```
2 changes: 1 addition & 1 deletion packages/embed/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@snipcode/embed",
"version": "1.1.2",
"version": "1.1.3",
"description": "Build the script and style assets for code snippet rendering in an embed.",
"repository": " https://github.com/tericcabrel/snipcode.git",
"author": "Eric Cabrel TIOGO <[email protected]>",
Expand Down
2 changes: 1 addition & 1 deletion packages/embed/package.publish.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@snipcode/embed",
"version": "1.1.2",
"version": "1.1.3",
"repository": {
"type": "git",
"url": "https://github.com/tericcabrel/snipcode.git"
Expand Down