Skip to content

Commit

Permalink
Merge pull request #44 from hibbitts-design/docsify-this-v1
Browse files Browse the repository at this point in the history
Docsify this v1
  • Loading branch information
paulhibbitts authored Aug 29, 2024
2 parents 71f36a0 + 2592db8 commit 8bd9720
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 104 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## [1.9.11] - XX/XX/2024

**Bugfix:**
* Fix Web Page Builder button lable handling on smaller screens
* Fix Web Page Builder button lable handling on smaller screens
* Removal of RunKit support due to unknown status of the platform

## [1.9.10] - 08/27/2024🏛️

Expand Down
33 changes: 1 addition & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Docsify-This can render files from anywhere that the content of a Markdown file

To directly render a file stored in a public GitHub repository when not using the above Web Page Builder, you need to use the raw source URL of that file (i.e. raw.githubusercontent.com) by tapping the **Raw** button when [viewing a file](https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file). It is also possible to render a file stored in a private GitHub repository by activating GitHub Pages within that repository and then using the GitHub Pages URL of that file (i.e. username.github.io).

The appearance of rendered Markdown files can be customized by optional [URL parameters](/?id=page-appearance-url-parameters) and a small set of available [CSS Classes](/?id=supported-markdown-css-classes) within source Markdown files. In addition to supporting standard Markdown, [Embed.ly](https://embed.ly/code), [H5P](https://h5p.org/), [Latex](https://github.com/scruel/docsify-latex), [Mermaid Diagrams](https://github.com/Leward/mermaid-docsify) and [RunKit](https://runkit.com/) are included. Optionally, page annotation with [Hypothes.is](https://hypothes.is) can be enabled.
The appearance of rendered Markdown files can be customized by optional [URL parameters](/?id=page-appearance-url-parameters) and a small set of available [CSS Classes](/?id=supported-markdown-css-classes) within source Markdown files. In addition to supporting standard Markdown, [Embed.ly](https://embed.ly/code), [H5P](https://h5p.org/), [Latex](https://github.com/scruel/docsify-latex) and [Mermaid Diagrams](https://github.com/Leward/mermaid-docsify) are included. Optionally, page annotation with [Hypothes.is](https://hypothes.is) can be enabled.

Looking for an overall introduction to publishing with Docsify-This? Check out [Markdown Publishing with Docsify-This](https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/publishing-with-docsify-this/main&sidebar=true&edit-link=https://github.com/hibbitts-design/publishing-with-docsify-this/blob/main/README.md&maxLevel=4&title=Markdown%20Publishing%20with%20Docsify-This).

Expand Down Expand Up @@ -974,37 +974,6 @@ function test() {
}
```

##### Including Interactive Javascript Blocks
Using the Docsify Plugin [RunKit](https://jhildenbiddle.github.io/docsify-plugin-runkit/) interactive JavaScript <abbr title="Read-Eval-Print Loop">REPLs</abbr> powered by RunKit can be embedded, for example to embed a data visualization rendered using [D3.js](https://d3js.org/) the following would be used:


````html
<div
data-runkit
>

```javascript
var R = require("ramda");
var randrange = require("random-number-in-range");
var d3Graph = require("@runkit/runkit/d3-graph/1.0.0");

var count = 100;
var nodes = R.range(0, 100).map((_, x) => ({ "name": x, "group": Math.floor(x * 7 / count) }));

var links = R.range(0, Math.floor(count * 1.15)).map(function(_, x) {
var source = x % count;
var target = Math.floor(Math.log(1 + randrange(0, count)) / Math.log(1.3));
var value = 10.0 / (1 + Math.abs(source - target));

return { "source": source, "target": target, "value": value };
});

d3Graph(nodes, links);
```

</div>
````

##### Including External Markdown Content

The content of external Markdown files can be embedded into Docisfy-This Web pages with the following:
Expand Down
60 changes: 1 addition & 59 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ Docsify-This can render files from anywhere that the content of a Markdown file

To directly render a file stored in a public GitHub repository when not using the above Web Page Builder, you need to use the raw source URL of that file (i.e. raw.githubusercontent.com) by tapping the **Raw** button when [viewing a file](https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file). It is also possible to render a file stored in a private GitHub repository by activating GitHub Pages within that repository and then using the GitHub Pages URL of that file (i.e. username.github.io).

The appearance of rendered Markdown files can be customized by optional [URL parameters](/?id=page-appearance-url-parameters) and a small set of available [CSS Classes](/?id=supported-markdown-css-classes) within source Markdown files. In addition to supporting standard Markdown, [Embed.ly](https://embed.ly/code), [H5P](https://h5p.org/), [Latex](https://github.com/scruel/docsify-latex), [Mermaid Diagrams](https://github.com/Leward/mermaid-docsify) and [RunKit](https://runkit.com/) are included. Optionally, page annotation with [Hypothes.is](https://hypothes.is) can be enabled.
The appearance of rendered Markdown files can be customized by optional [URL parameters](/?id=page-appearance-url-parameters) and a small set of available [CSS Classes](/?id=supported-markdown-css-classes) within source Markdown files. In addition to supporting standard Markdown, [Embed.ly](https://embed.ly/code), [H5P](https://h5p.org/), [Latex](https://github.com/scruel/docsify-latex) and [Mermaid Diagrams](https://github.com/Leward/mermaid-docsify) are included. Optionally, page annotation with [Hypothes.is](https://hypothes.is) can be enabled.

Looking for an overall introduction to publishing with Docsify-This? Check out [Markdown Publishing with Docsify-This](https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/publishing-with-docsify-this/main&sidebar=true&edit-link=https://github.com/hibbitts-design/publishing-with-docsify-this/blob/main/README.md&maxLevel=4&title=Markdown%20Publishing%20with%20Docsify-This).

Expand Down Expand Up @@ -1310,64 +1310,6 @@ function test() {
}
```

##### Including Interactive Javascript Blocks
Using the Docsify Plugin [RunKit](https://jhildenbiddle.github.io/docsify-plugin-runkit/) interactive JavaScript <abbr title="Read-Eval-Print Loop">REPLs</abbr> powered by RunKit can be embedded, for example to embed a data visualization rendered using [D3.js](https://d3js.org/) the following would be used:


````html
<div
data-runkit
>

```javascript
var R = require("ramda");
var randrange = require("random-number-in-range");
var d3Graph = require("@runkit/runkit/d3-graph/1.0.0");

var count = 100;
var nodes = R.range(0, 100).map((_, x) => ({ "name": x, "group": Math.floor(x * 7 / count) }));

var links = R.range(0, Math.floor(count * 1.15)).map(function(_, x) {
var source = x % count;
var target = Math.floor(Math.log(1 + randrange(0, count)) / Math.log(1.3));
var value = 10.0 / (1 + Math.abs(source - target));

return { "source": source, "target": target, "value": value };
});

d3Graph(nodes, links);
```

</div>
````

Which would then appear as:

<div data-runkit>

```javascript
var R = require("ramda");
var randrange = require("random-number-in-range");
var d3Graph = require("@runkit/runkit/d3-graph/1.0.0");

var count = 100;
var nodes = R.range(0, 100).map((_, x) => ({ "name": x, "group": Math.floor(x * 7 / count) }));

var links = R.range(0, Math.floor(count * 1.15)).map(function(_, x) {
var source = x % count;
var target = Math.floor(Math.log(1 + randrange(0, count)) / Math.log(1.3));
var value = 10.0 / (1 + Math.abs(source - target));

return { "source": source, "target": target, "value": value };
});

d3Graph(nodes, links);
```

</div>

**Tip:** Press <kbd>⇧ Shift</kbd> <kbd>⌤ Enter</kbd> to "run" the notebook.

##### Including External Markdown Content

The content of external Markdown files can be embedded into Docisfy-This Web pages with the following:
Expand Down
9 changes: 0 additions & 9 deletions docs/assets/vendor/docsify/plugins/docsify-runkit.js

This file was deleted.

3 changes: 0 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1677,9 +1677,6 @@
}
</script>

<!-- RunKit Plugin -->
<script src="assets/vendor/docsify/plugins/docsify-runkit.js"></script>

<!-- Frontmatter Plugin -->
<script src="assets/vendor/docsify/plugins/docsify-frontmatter.min.js"></script>

Expand Down

0 comments on commit 8bd9720

Please sign in to comment.