Skip to content

Update a bunch of links #1105

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.

Sign up for GitHub

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

Open
fingolfin wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update a bunch of links #1105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions .github/workflows/TagBot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ on:
types:
- created
workflow_dispatch:
inputs:
lookback:
default: 3
permissions:
contents: write
jobs:
TagBot:
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
Expand All @@ -12,3 +17,4 @@ jobs:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
ssh: ${{ secrets.DOCUMENTER_KEY }}
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ See [the docs](https://franklinjl.org) for more information and examples.

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!_)

**Adapted templates** (i.e. starting from one of [the available themes](https://tlienart.github.io/FranklinTemplates.jl/))
**Adapted templates** (i.e. starting from one of [the available themes](https://juliadocs.org/FranklinTemplates.jl/))
* Franklin's own website is written in Franklin, [see docs/](docs/)
* [@cormullion's website](https://cormullion.github.io), the author of [Luxor.jl](https://github.com/JuliaGraphics/Luxor.jl),
* 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)
Expand All @@ -80,7 +80,7 @@ Some examples of websites using Franklin (_if you're using Franklin with a publi
* The [Julia website](https://julialang.org), including the blog, are deployed using Franklin ([repo](https://github.com/JuliaLang/www.julialang.org))
* [Circuitscape's website](https://circuitscape.org) was migrated from Jekyll ([repo](https://github.com/Circuitscape/www.circuitscape.org))
* [@zlatanvasovic's website](https://zlatanvasovic.github.io) using Bootstrap 4.5 ([repo](https://github.com/zlatanvasovic/zlatanvasovic.github.io))
* [PkgPage.jl](https://tlienart.github.io/PkgPage.jl/), front-page generator based on Franklin using Bootstrap 4.5
* [PkgPage.jl](https://juliadocs.org/PkgPage.jl/), front-page generator based on Franklin using Bootstrap 4.5
* [@abhishalya's website](https://abhishalya.github.io) using a custom minimalistic theme ([repo](https://github.com/abhishalya/abhishalya.github.io))
* [JuliaCon's website](https://juliacon.org) using Franklin and Bootstrap ([repo](https://github.com/JuliaCon/www.juliacon.org))
* [JuliaGPU's website](https://juliagpu.org) using Franklin and a custom template ([repo](https://github.com/JuliaGPU/juliagpu.org))
Expand Down Expand Up @@ -114,7 +114,7 @@ julia> serve()
Modify the files in `MyNewSite/src` and see the changes being live-rendered in your browser.
Head to [the docs](https://franklinjl.org) for more information.

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

```julia
julia> newsite("MyNewSite", template="vela")
Expand Down
2 changes: 1 addition & 1 deletion demos/_layout/page_foot.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="page-foot">
<div class="copyright">
&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>.
&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>.
</div>
</div>

Expand Down
20 changes: 10 additions & 10 deletions demos/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ hasmath = true

# Franklin Demos

\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)}
\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)}

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/).

It's not meant to be beautiful, rather just show how to get specific stuff done.
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.
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.
The ordering is reverse chronological but just use the table of contents to guide you to whatever you might want to explore.

**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.
Expand All @@ -39,7 +39,7 @@ will be rendered as:

{{ render_table }}

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).
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).



Expand Down Expand Up @@ -194,8 +194,8 @@ Here's an example with the insertion of the content of a file `foo/content.md`;

{{insertmd foo/content.md}}

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.
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.
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.
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.

## (012) Dates

Expand Down Expand Up @@ -240,15 +240,15 @@ It's fairly easy to add a "copy" button to your code blocks using a tool like [
In fact on this demo page, as you can see, there is a copy button on all code blocks.
The steps to reproduce this are:

* 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_)
* 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_)
* load that in `_layout/head.html` adding something like

```html
<script src="/libs/clipboard.min.js"></script>
```

* add Javascript in the `_layout/foot.html`, something [like this](https://github.com/tlienart/Franklin.jl/blob/master/demos/_layout/foot_clipboard.html)
* adjust the CSS, for instance [something like this](https://github.com/tlienart/Franklin.jl/blob/0276b1afb054017ff7e81bc7d083021a867a4b92/demos/_css/extras.css#L37-L61)
* add Javascript in the `_layout/foot.html`, something [like this](https://github.com/JuliaDocs/Franklin.jl/blob/master/demos/_layout/foot_clipboard.html)
* adjust the CSS, for instance [something like this](https://github.com/JuliaDocs/Franklin.jl/blob/0276b1afb054017ff7e81bc7d083021a867a4b92/demos/_css/extras.css#L37-L61)

and that's it 🏁.

Expand Down Expand Up @@ -481,7 +481,7 @@ Now observe that

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.

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:
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:

```julia:lx1
using Latexify
Expand All @@ -494,7 +494,7 @@ println(ls.s) # hide

## (003) styling of code output blocks

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`):
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`):

```julia:cos1
x = 7
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Franklin Docs

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

## Dev note

Expand Down
4 changes: 2 additions & 2 deletions docs/_layout/head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,9 @@
<div class="main-header">
<a name="pagetop"></a>

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

<!-- Content appended here (in class franklin-content) -->
2 changes: 1 addition & 1 deletion docs/_layout/page_foot.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div class="page-foot">
<div class="copyright">
&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>.
&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>.
</div>
</div>
2 changes: 1 addition & 1 deletion docs/_libs/lunr/lunr_index.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extras/lunr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ $> npm install cheerio

### Files

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

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).
Expand Down
8 changes: 4 additions & 4 deletions docs/faq/technical.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

# FAQ - Technical

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!
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!

\toc

## Styling

### Can you style footnote text?

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

For reference basically, a footnote is inserted as

Expand Down Expand Up @@ -97,7 +97,7 @@ like this: \eqref{eqabc}.

### How to use loops for templating?

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

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.
For instance:
Expand Down Expand Up @@ -128,6 +128,6 @@ Generates

### How to insert Plotly plots?

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

See [this tutorial](/extras/plotly/) for a way to do this.
2 changes: 1 addition & 1 deletion docs/faq/why-o-why.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ I liked that Jemdoc+Mathjax was simple to use and didn't require a lot of web-de
That's how I got the idea of doing something similar in Julia, hopefully improving on the few things I didn't like such as the lack of support for live-rendering preview or the speed of page generation.

That being said, if you just want a blogging generator mostly for text and pictures, then Franklin may not be the tool for you.
If you want to host a technical blog with maths, an code blocks, and would like some easy and reproducible control over elements, then Franklin could help you (feel free to [open an issue](https://github.com/tlienart/Franklin.jl/issues/new) to see if Franklin is right for you).
If you want to host a technical blog with maths, an code blocks, and would like some easy and reproducible control over elements, then Franklin could help you (feel free to [open an issue](https://github.com/JuliaDocs/Franklin.jl/issues/new) to see if Franklin is right for you).

### Why not Pandoc?

Expand Down
8 changes: 4 additions & 4 deletions docs/styling/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ reviewed: 22/12/19

\lineskip

The pre-defined templates that are currently available in Franklin with the `newsite` function can be viewed ~~~<a href="https://tlienart.github.io/FranklinTemplates.jl/" target="_blank" rel="noopener noreferrer">here</a>~~~ (_opens in a new tab_).
The pre-defined templates that are currently available in Franklin with the `newsite` function can be viewed ~~~<a href="https://juliadocs.org/FranklinTemplates.jl/" target="_blank" rel="noopener noreferrer">here</a>~~~ (_opens in a new tab_).

## Adapting a theme to Franklin

\note{If you end up doing this, please consider making a PR to [FranklinTemplates](https://github.com/tlienart/FranklinTemplates.jl)!}
\note{If you end up doing this, please consider making a PR to [FranklinTemplates](https://github.com/JuliaDocs/FranklinTemplates.jl)!}

On this page, I'll take [Jemdoc's website layout](http://jemdoc.jaboc.net/) and show how it can be adapted to be a working Franklin template.
This will hopefully also show you how to adapt/modify an existing template.
Expand Down Expand Up @@ -233,7 +233,7 @@ By default `page_foot` looks like
```html
<div class="page-foot">
<div class="copyright">
&copy; {{ fill author }}. Last modified: {{ fill fd_mtime }}. Website built with <a href="https://github.com/tlienart/Franklin.jl">Franklin.jl</a>.
&copy; {{ fill author }}. Last modified: {{ fill fd_mtime }}. Website built with <a href="https://github.com/JuliaDocs/Franklin.jl">Franklin.jl</a>.
</div>
</div>
```
Expand All @@ -244,4 +244,4 @@ It should be fairly straightforward to adapt that to your needs.

Let's say you've built your own template and are pretty happy with the result and you'd like to share it with other users, great, thanks!

Please follow [these instructions](https://github.com/tlienart/FranklinTemplates.jl#fixingadding-a-template).
Please follow [these instructions](https://github.com/JuliaDocs/FranklinTemplates.jl#fixingadding-a-template).
2 changes: 1 addition & 1 deletion docs/syntax/markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ If you do this, you might want to slightly modify it to ensure that the Julia-re
hljs.registerLanguage("julia-repl",function(a){return{c:[{cN:"meta",b:/^julia>/,r:10,starts:{e:/^(?![ ]{6})/,sL:"julia"}},{cN:"metas",b:/^shell>/,r:10,starts:{e:/^(?![ ]{6})/,sL:"bash"}},{cN:"metap",b:/^\(.*\)\spkg>/,r:10,starts:{e:/^(?![ ]{6})/,sL:"julia"}}]}});
```

(see also [the README](https://github.com/tlienart/FranklinTemplates.jl#notes) of FranklinTemplates).
(see also [the README](https://github.com/JuliaDocs/FranklinTemplates.jl#notes) of FranklinTemplates).

### Evaluated code blocks

Expand Down
4 changes: 2 additions & 2 deletions docs/syntax/page-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,13 +235,13 @@ These variables are best defined in your `config.md` file though you can overwri
| `date_shortmonths` | `Vector{String}` | `String[]` | Short names for months (\*\*)
| `div_content` | `String` | `"franklin-content"` | Name of the div that will englobe the processed content between `head` and `foot`
| `ignore` | `Vector{String}` | `String[]` | Files that should be ignored by Franklin (\*\*\*)
| `folder_structure` | `VersionNumber` | `v"0.2"` | only relevant for users of Franklin < 0.5, see [NEWS.md](http://github.com/tlienart/Franklin.jl/NEWS.md)
| `folder_structure` | `VersionNumber` | `v"0.2"` | only relevant for users of Franklin < 0.5, see [NEWS.md](http://github.com/JuliaDocs/Franklin.jl/NEWS.md)
@@

**Notes**:\\
\smindent{(\*)} \smnote{Say you're using GitHub pages and your username is `darth`, by default Franklin will assume the root URL to be `darth.github.io/`. However, if you want to build a project page so that the base URL is `darth.github.io/vador/` then use `@def prepath = "vador"`}\\
\smindent{(\*\*)} \smnote{Must be in a format recognized by Julia's `Dates.DateLocale`. Defaults to English. If left unset, the short names are created automatically by using the first three characters of the full names.}\\
\smindent{(\*\*\*)} \smnote{To ignore a file add it's relative path like `"path/to/file.md"`, to ignore a directory end the path with a `/` like `"path/to/dir/"`. Always ignored are `.DS_Store`, `.gitignore`, `LICENSE.md`, `README.md`, `franklin`, `franklin.pub`, and `node_modules/` (see [`IGNORE_FILES`](https://github.com/tlienart/Franklin.jl/blob/9fd952da679cfc2e2687a2b858cf4ad1401e8fc1/src/utils/paths.jl#L14)).}
\smindent{(\*\*\*)} \smnote{To ignore a file add it's relative path like `"path/to/file.md"`, to ignore a directory end the path with a `/` like `"path/to/dir/"`. Always ignored are `.DS_Store`, `.gitignore`, `LICENSE.md`, `README.md`, `franklin`, `franklin.pub`, and `node_modules/` (see [`IGNORE_FILES`](https://github.com/JuliaDocs/Franklin.jl/blob/9fd952da679cfc2e2687a2b858cf4ad1401e8fc1/src/utils/paths.jl#L14)).}

### Other global settings

Expand Down
2 changes: 1 addition & 1 deletion docs/syntax/rss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ this feed so that readers can more easily stay up to date with your new content.

There is a Franklin-generated `_rss` folder that contains two parts: `head.xml`
& `item.xml` (if this is not present for you, then copy the files from the
[FranklinTemplates source](https://github.com/tlienart/FranklinTemplates.jl/tree/master/src/templates/common/_rss).
[FranklinTemplates source](https://github.com/JuliaDocs/FranklinTemplates.jl/tree/master/src/templates/common/_rss).

The complete RSS feed will be built by assembling

Expand Down
2 changes: 1 addition & 1 deletion docs/syntax/utils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ end

\note{The same comment as earlier, you can see that the way the function is called depends on the name of the function definition `lx_foo` ⟶ `foo`. Make sure that the name does not clash with one of the pre-defined commands (`label`, `style`, ...).}

\note{For the moment, this only works with a single brace see [issue 518](https://github.com/tlienart/Franklin.jl/issues/518) for comments.}
\note{For the moment, this only works with a single brace see [issue 518](https://github.com/JuliaDocs/Franklin.jl/issues/518) for comments.}

### Why it was a dumb example

Expand Down
Loading
Loading