Skip to content

Commit 014c6ce

Browse files
committed
Update a bunch of links
1 parent f04545a commit 014c6ce

File tree

23 files changed

+48
-42
lines changed

23 files changed

+48
-42
lines changed

.github/workflows/TagBot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ on:
44
types:
55
- created
66
workflow_dispatch:
7+
inputs:
8+
lookback:
9+
default: 3
10+
permissions:
11+
contents: write
712
jobs:
813
TagBot:
914
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
@@ -12,3 +17,4 @@ jobs:
1217
- uses: JuliaRegistries/TagBot@v1
1318
with:
1419
token: ${{ secrets.GITHUB_TOKEN }}
20+
ssh: ${{ secrets.DOCUMENTER_KEY }}

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ See [the docs](https://franklinjl.org) for more information and examples.
5454

5555
Some examples of websites using Franklin (_if you're using Franklin with a public repo, consider adding the "franklin" tag to the repo to help others find examples, thanks!_)
5656

57-
**Adapted templates** (i.e. starting from one of [the available themes](https://tlienart.github.io/FranklinTemplates.jl/))
57+
**Adapted templates** (i.e. starting from one of [the available themes](https://juliadocs.org/FranklinTemplates.jl/))
5858
* Franklin's own website is written in Franklin, [see docs/](docs/)
5959
* [@cormullion's website](https://cormullion.github.io), the author of [Luxor.jl](https://github.com/JuliaGraphics/Luxor.jl),
6060
* MLJ's [tutorial website](https://alan-turing-institute.github.io/DataScienceTutorials.jl/) which shows how Franklin can interact nicely with [Literate.jl](https://github.com/fredrikekre/Literate.jl)
@@ -80,7 +80,7 @@ Some examples of websites using Franklin (_if you're using Franklin with a publi
8080
* The [Julia website](https://julialang.org), including the blog, are deployed using Franklin ([repo](https://github.com/JuliaLang/www.julialang.org))
8181
* [Circuitscape's website](https://circuitscape.org) was migrated from Jekyll ([repo](https://github.com/Circuitscape/www.circuitscape.org))
8282
* [@zlatanvasovic's website](https://zlatanvasovic.github.io) using Bootstrap 4.5 ([repo](https://github.com/zlatanvasovic/zlatanvasovic.github.io))
83-
* [PkgPage.jl](https://tlienart.github.io/PkgPage.jl/), front-page generator based on Franklin using Bootstrap 4.5
83+
* [PkgPage.jl](https://juliadocs.org/PkgPage.jl/), front-page generator based on Franklin using Bootstrap 4.5
8484
* [@abhishalya's website](https://abhishalya.github.io) using a custom minimalistic theme ([repo](https://github.com/abhishalya/abhishalya.github.io))
8585
* [JuliaCon's website](https://juliacon.org) using Franklin and Bootstrap ([repo](https://github.com/JuliaCon/www.juliacon.org))
8686
* [JuliaGPU's website](https://juliagpu.org) using Franklin and a custom template ([repo](https://github.com/JuliaGPU/juliagpu.org))
@@ -114,7 +114,7 @@ julia> serve()
114114
Modify the files in `MyNewSite/src` and see the changes being live-rendered in your browser.
115115
Head to [the docs](https://franklinjl.org) for more information.
116116

117-
You can also start from [one of the templates](https://tlienart.github.io/FranklinTemplates.jl/) by doing something like:
117+
You can also start from [one of the templates](https://juliadocs.org/FranklinTemplates.jl/) by doing something like:
118118

119119
```julia
120120
julia> newsite("MyNewSite", template="vela")

demos/_layout/page_foot.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="page-foot">
22
<div class="copyright">
3-
&copy; {{ fill author }}. {{isnotpage /tag/*}}Last modified: {{ fill fd_mtime }}.{{end}} Website built with <a href="https://github.com/tlienart/Franklin.jl">Franklin.jl</a>.
3+
&copy; {{ fill author }}. {{isnotpage /tag/*}}Last modified: {{ fill fd_mtime }}.{{end}} Website built with <a href="https://github.com/JuliaDocs/Franklin.jl">Franklin.jl</a>.
44
</div>
55
</div>
66

demos/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ hasmath = true
77

88
# Franklin Demos
99

10-
\style{text-align:center;width:100%;display:inline-block;font-variant-caps:small-caps}{[**Click here to see the source**](https://github.com/tlienart/Franklin.jl/tree/master/demos)}
10+
\style{text-align:center;width:100%;display:inline-block;font-variant-caps:small-caps}{[**Click here to see the source**](https://github.com/JuliaDocs/Franklin.jl/tree/master/demos)}
1111

1212
This website is meant to be a quick way to show how to do stuff that people ask (or that I thought would be a nice demo), it will complement the [official documentation](https://franklinjl.org/).
1313

1414
It's not meant to be beautiful, rather just show how to get specific stuff done.
15-
If one block answers one of your question, make sure to check [the source](https://github.com/tlienart/Franklin.jl/tree/master/demos/index.md) to see how it was done.
15+
If one block answers one of your question, make sure to check [the source](https://github.com/JuliaDocs/Franklin.jl/tree/master/demos/index.md) to see how it was done.
1616
The ordering is reverse chronological but just use the table of contents to guide you to whatever you might want to explore.
1717

1818
**Note**: an important philosophy here is that if you can write a Julia function that would produce the HTML you want, then write that function and let Franklin call it.
@@ -39,7 +39,7 @@ will be rendered as:
3939

4040
{{ render_table }}
4141

42-
This done via a `hfun_render_table` which can be found in [`utils.jl`](https://github.com/tlienart/Franklin.jl/blob/master/demos/utils.jl).
42+
This done via a `hfun_render_table` which can be found in [`utils.jl`](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/utils.jl).
4343

4444

4545

@@ -194,8 +194,8 @@ Here's an example with the insertion of the content of a file `foo/content.md`;
194194
195195
{{insertmd foo/content.md}}
196196
197-
You can look at [`utils.jl`](https://github.com/tlienart/Franklin.jl/blob/master/demos/utils.jl) for the definition of the `hfun` (same as above), at [`index.md`](https://github.com/tlienart/Franklin.jl/blob/master/demos/index.md) to see how it's called and at [`foo/content.md`](https://github.com/tlienart/Franklin.jl/blob/master/demos/foo/content.md) for the content file.
198-
Finally you can also check out the [`config.md`](https://github.com/tlienart/Franklin.jl/blob/master/demos/config.md) file to see how the content page is ignored.
197+
You can look at [`utils.jl`](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/utils.jl) for the definition of the `hfun` (same as above), at [`index.md`](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/index.md) to see how it's called and at [`foo/content.md`](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/foo/content.md) for the content file.
198+
Finally you can also check out the [`config.md`](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/config.md) file to see how the content page is ignored.
199199
200200
## (012) Dates
201201
@@ -240,15 +240,15 @@ It's fairly easy to add a "copy" button to your code blocks using a tool like [
240240
In fact on this demo page, as you can see, there is a copy button on all code blocks.
241241
The steps to reproduce this are:
242242
243-
* copy the [`clipboard.min.js`](https://github.com/tlienart/Franklin.jl/blob/master/demos/_libs/clipboard.min.js) to `/libs/clipboard.min.js` (_note that this is an old version of the library, `1.4` or something, if you take the most recent version, you will have to adapt the script_)
243+
* copy the [`clipboard.min.js`](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/_libs/clipboard.min.js) to `/libs/clipboard.min.js` (_note that this is an old version of the library, `1.4` or something, if you take the most recent version, you will have to adapt the script_)
244244
* load that in `_layout/head.html` adding something like
245245
246246
```html
247247
<script src="/libs/clipboard.min.js"></script>
248248
```
249249
250-
* add Javascript in the `_layout/foot.html`, something [like this](https://github.com/tlienart/Franklin.jl/blob/master/demos/_layout/foot_clipboard.html)
251-
* adjust the CSS, for instance [something like this](https://github.com/tlienart/Franklin.jl/blob/0276b1afb054017ff7e81bc7d083021a867a4b92/demos/_css/extras.css#L37-L61)
250+
* add Javascript in the `_layout/foot.html`, something [like this](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/_layout/foot_clipboard.html)
251+
* adjust the CSS, for instance [something like this](https://github.com/JuliaDocs/Franklin.jl/blob/0276b1afb054017ff7e81bc7d083021a867a4b92/demos/_css/extras.css#L37-L61)
252252
253253
and that's it 🏁.
254254
@@ -481,7 +481,7 @@ Now observe that
481481
482482
Latexify produces a LaTeX string which should basically be passed to KaTeX. To do that you need to recuperate the output, extract the string and pass it into a maths block.
483483
484-
Here there's a bug with `\begin{equation}` in Franklin (issue [#584](https://github.com/tlienart/Franklin.jl/issues/584)) which is why I'm replacing those with `$$` but it should be fixed in the near future so that you wouldn't have to use these two "replace" lines:
484+
Here there's a bug with `\begin{equation}` in Franklin (issue [#584](https://github.com/JuliaDocs/Franklin.jl/issues/584)) which is why I'm replacing those with `$$` but it should be fixed in the near future so that you wouldn't have to use these two "replace" lines:
485485
486486
```julia:lx1
487487
using Latexify
@@ -494,7 +494,7 @@ println(ls.s) # hide
494494
495495
## (003) styling of code output blocks
496496
497-
At the moment (August 2020) no particular class is added on an output (see [#531](https://github.com/tlienart/Franklin.jl/issues/531)); you can still do something similar by adding a `@@code-output` (or whatever appropriate name) around the command that extracts the output and specify this in your css (see `extras.css`):
497+
At the moment (August 2020) no particular class is added on an output (see [#531](https://github.com/JuliaDocs/Franklin.jl/issues/531)); you can still do something similar by adding a `@@code-output` (or whatever appropriate name) around the command that extracts the output and specify this in your css (see `extras.css`):
498498
499499
```julia:cos1
500500
x = 7

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Franklin Docs
22

3-
Website & documentation for [Franklin.jl](https://github.com/tlienart/Franklin.jl).
3+
Website & documentation for [Franklin.jl](https://github.com/JuliaDocs/Franklin.jl).
44

55
## Dev note
66

docs/_layout/head.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@
134134
<div class="main-header">
135135
<a name="pagetop"></a>
136136

137-
<a id="github" href="https://github.com/tlienart/Franklin.jl/blob/master/docs/{{fd_rpath}}">Page source</a>
137+
<a id="github" href="https://github.com/JuliaDocs/Franklin.jl/blob/master/docs/{{fd_rpath}}">Page source</a>
138138
<span style="width:30px; text-align: center;color:lightgray;">|</span>
139-
<a id="github" href="https://github.com/tlienart/Franklin.jl">GitHub Repository</a>
139+
<a id="github" href="https://github.com/JuliaDocs/Franklin.jl">GitHub Repository</a>
140140
</div>
141141

142142
<!-- Content appended here (in class franklin-content) -->

docs/_layout/page_foot.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div class="page-foot">
22
<div class="copyright">
3-
&copy; {{ fill author }}. Last modified: {{ fill fd_mtime }}. Website built with <a href="https://github.com/tlienart/Franklin.jl">Franklin.jl</a> and the <a href="https://julialang.org">Julia programming language</a>.
3+
&copy; {{ fill author }}. Last modified: {{ fill fd_mtime }}. Website built with <a href="https://github.com/JuliaDocs/Franklin.jl">Franklin.jl</a> and the <a href="https://julialang.org">Julia programming language</a>.
44
</div>
55
</div>

docs/_libs/lunr/lunr_index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/extras/lunr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ $> npm install cheerio
2424

2525
### Files
2626

27-
Copy [this folder](https://github.com/tlienart/Franklin.jl/tree/master/docs/_libs/lunr) to a `/_libs/lunr/` directory.
27+
Copy [this folder](https://github.com/JuliaDocs/Franklin.jl/tree/master/docs/_libs/lunr) to a `/_libs/lunr/` directory.
2828
Discard the `lunr_index.js` which is the index of this website, a version for your website will be generated dynamically.
2929

3030
The important files are `build_index.js` and `lunrclient.js` (of which a minified version is provided which you will want to re-generate if you modify the base file).

docs/faq/technical.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
# FAQ - Technical
55

6-
If you have a question that you couldn't find an answer to easily, don't hesitate to [open an issue](https://github.com/tlienart/Franklin.jl/issues/new) on GitHub, it will help me make this section more complete!
6+
If you have a question that you couldn't find an answer to easily, don't hesitate to [open an issue](https://github.com/JuliaDocs/Franklin.jl/issues/new) on GitHub, it will help me make this section more complete!
77

88
\toc
99

1010
## Styling
1111

1212
### Can you style footnote text?
1313

14-
**Reference**: [issue 243](https://github.com/tlienart/Franklin.jl/issues/243), **more on this**: [styling](/styling/classes/).
14+
**Reference**: [issue 243](https://github.com/JuliaDocs/Franklin.jl/issues/243), **more on this**: [styling](/styling/classes/).
1515

1616
For reference basically, a footnote is inserted as
1717

@@ -97,7 +97,7 @@ like this: \eqref{eqabc}.
9797

9898
### How to use loops for templating?
9999

100-
**Reference**: [issue 251](https://github.com/tlienart/Franklin.jl/issues/251), **more on this**: [code tricks](/code/eval-tricks/).
100+
**Reference**: [issue 251](https://github.com/JuliaDocs/Franklin.jl/issues/251), **more on this**: [code tricks](/code/eval-tricks/).
101101

102102
Since you can show the output of any Julia code block (and interpret that output as Franklin markdown), you can use this to help with templating.
103103
For instance:
@@ -128,6 +128,6 @@ Generates
128128

129129
### How to insert Plotly plots?
130130

131-
**Reference**: [issue 322](https://github.com/tlienart/Franklin.jl/issues/322).
131+
**Reference**: [issue 322](https://github.com/JuliaDocs/Franklin.jl/issues/322).
132132

133133
See [this tutorial](/extras/plotly/) for a way to do this.

0 commit comments

Comments
 (0)