Skip to content

Commit

Permalink
🐛 docs: update require name
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfram77 committed Apr 11, 2023
1 parent 5102f8f commit 81d4ebe
Show file tree
Hide file tree
Showing 5 changed files with 119 additions and 90 deletions.
11 changes: 7 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ on:
tags:
- '!*' # Do not execute on tags
env:
NAME: ${{vars.NAME}}
EMAIL: ${{vars.EMAIL}}
NPM_TOKEN: ${{secrets.NPM_TOKEN}}
GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
FORCE_COLOR: 1
Expand Down Expand Up @@ -55,8 +58,7 @@ jobs:
- uses: actions/setup-node@v2
with:
node-version: 18.x
- run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
- run: bash "$HOME/deploy/setup.sh"
- uses: nodef/[email protected]
- run: npm i -g typescript typedoc
- run: npm ci
- run: npm run publish-docs
Expand All @@ -71,8 +73,9 @@ jobs:
- uses: actions/setup-node@v2
with:
node-version: 18.x
- run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
- run: bash "$HOME/deploy/setup.sh"
- uses: nodef/[email protected]
with:
entries: access = public
- run: npm i -g typescript rollup typedoc browserify terser
- run: npm ci
- run: npm run publish-packages
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Utilities for processing JavaScript text.<br>
📜 [Files](https://unpkg.com/extra-javascript-text/),
📰 [Docs](https://nodef.github.io/extra-javascript-text/).

This package is available in both *Node.js* and *Web* formats. The web format
is exposed as `extra_javascript_text` standalone variable and can be loaded from
[jsDelivr CDN].
This package is available in *Node.js* and *Web* formats. To use it on the web,
simply use the `extra_javascript_text` global variable after loading with a `<script>`
tag from the [jsDelivr CDN].

> Stability: [Experimental](https://www.youtube.com/watch?v=L1j93RnIxEo).
Expand All @@ -15,17 +15,17 @@ is exposed as `extra_javascript_text` standalone variable and can be loaded from
<br>

```javascript
const fs = require('fs');
const javascript = require('extra-javascript-text');
const fs = require('fs');
const xjavascript = require('extra-javascript-text');


function main() {
var txt = fs.readFileSync('src/index.ts', 'utf8').replace(/\r?\n/, '\n');

javascript.importSymbols(txt);
xjavascript.importSymbols(txt);
// []

javascript.exportSymbols(txt);
xjavascript.exportSymbols(txt);
// [
// {
// full: 'export function tagStrings',
Expand All @@ -42,7 +42,7 @@ function main() {
// ...
// ]

javascript.jsdocSymbols(txt);
xjavascript.jsdocSymbols(txt);
// [
// {
// full: '/**\r\n' +
Expand Down
167 changes: 95 additions & 72 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 81d4ebe

Please sign in to comment.