Skip to content

Commit

Permalink
name Change to repo name
Browse files Browse the repository at this point in the history
  • Loading branch information
themantra108 committed Jun 21, 2023
1 parent 65696f4 commit c49a959
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![CI](https://github.com/themantra108/plutoTemplate/actions/workflows/CI.yml/badge.svg)](https://github.com/themantra108/plutoTemplate/actions/workflows/CI.yml)

# JuliaTutorialsTemplate
# plutoTemplate

See <http://rikhuijzer.github.io/JuliaTutorialsTemplate/> for more information.
See <http://rikhuijzer.github.io/plutoTemplate/> for more information.
2 changes: 1 addition & 1 deletion _layout/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<style>
@font-face {
font-family: JuliaMono-Regular;
src: url("/JuliaTutorialsTemplate/{{artifact JuliaMono juliamono-0.044 webfonts JuliaMono-Regular.woff2}}");
src: url("/plutoTemplate/{{artifact JuliaMono juliamono-0.044 webfonts JuliaMono-Regular.woff2}}");
}
</style>

Expand Down
6 changes: 3 additions & 3 deletions _layout/head_math.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@

<style>
@font-face {
src: url("/JuliaTutorialsTemplate/{{artifact MathJax MathJax-3.2.2 es5 output chtml fonts woff-v2 MathJax_Main-Regular.woff }}">
src: url("/plutoTemplate/{{artifact MathJax MathJax-3.2.2 es5 output chtml fonts woff-v2 MathJax_Main-Regular.woff }}">
}
</style>

<style>
@font-face {
src: url("/JuliaTutorialsTemplate/{{artifact MathJax MathJax-3.2.2 es5 output chtml fonts woff-v2 MathJax_Zero.woff }}">
src: url("/plutoTemplate/{{artifact MathJax MathJax-3.2.2 es5 output chtml fonts woff-v2 MathJax_Zero.woff }}">
}
</style>

<style>
@font-face {
src: url("/JuliaTutorialsTemplate/{{artifact MathJax MathJax-3.2.2 es5 output chtml fonts woff-v2 MathJax_Math-Italic.woff }}">
src: url("/plutoTemplate/{{artifact MathJax MathJax-3.2.2 es5 output chtml fonts woff-v2 MathJax_Math-Italic.woff }}">
}
</style>
2 changes: 1 addition & 1 deletion _layout/menu.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div class="docs-navbar">
<a class="off-canvas-toggle btn btn-link btn-action" href="#sidebar"><i class="icon icon-menu"></i></a>
<div class="btns d-flex">
<a class="btn btn-primary ml-1" href="https://github.com/rikhuijzer/JuliaTutorialsTemplate">GitHub</a>
<a class="btn btn-primary ml-1" href="https://github.com/rikhuijzer/plutoTemplate">GitHub</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion config.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ prepath = "plutoTemplate"
generate_rss = false
website_title = "plutoTemplate"
website_descr = "Example website containing Julia tutorials"
website_url = "https://rikhuijzer.github.io/JuliaTutorialsTemplate/"
website_url = "https://rikhuijzer.github.io/plutoTemplate/"
+++

6 changes: 3 additions & 3 deletions getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Instead of manually having to run the tutorial after fixing the typo and upload
The CI will automatically re-run any notebooks that it needs to run and update the website.

So, to have your own tutorials and CI and website, a new repository has to be created based on this template.
To do so, go to <https://github.com/rikhuijzer/JuliaTutorialsTemplate> and click on the big "Use this template" button.
To do so, go to <https://github.com/rikhuijzer/plutoTemplate> and click on the big "Use this template" button.
In the new page that opens, give your project a nice name click on "Create repository from template".
Do not select "Include all branches".
Next, GitHub will say "Generating your repository" for a few seconds and then you have your new repository 🎉.
Expand All @@ -33,7 +33,7 @@ That CI thing mentioned above is called GitHub Actions.
When clicking on the Actions tab near the top of the page, there should be one workflow run visible.
It should either be orange, which means running, or green, which means successfully finished.
If this is the case, then you're ready to go to the next step 🎈.
Otherwise, enable the GitHub Actions in the repository settings or open an issue at <https://github.com/rikhuijzer/JuliaTutorialsTemplate/issues/new>.
Otherwise, enable the GitHub Actions in the repository settings or open an issue at <https://github.com/rikhuijzer/plutoTemplate/issues/new>.

## Enable the website

Expand Down Expand Up @@ -71,7 +71,7 @@ title = "$title"
Add these blocks in your website to let Franklin know what the page title should be.
Also remove the old tutorials while you are in that folder.

Next, search for `JuliaTutorialsTemplate` inside your repository and replace all occurrences of that word by the name of your repository.
Next, search for `plutoTemplate` inside your repository and replace all occurrences of that word by the name of your repository.
It is especially important to set the right `prepath` in `config.md` since otherwise the CSS will not work on the website.

Also, go to the menu in `_layout/menu.html` and find the lines containing "menu-header" and "menu-item".
Expand Down
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags = ["code", "tutorials"]

This is a template repository which can be used to create Julia tutorials websites.
To use this website as a template, go to
<https://github.com/rikhuijzer/JuliaTutorialsTemplate>
<https://github.com/rikhuijzer/plutoTemplate>
and click on the big "Use this template" button.

Some general information is provided below.
Expand All @@ -29,7 +29,7 @@ These steps all run in an automated workflow, so changing a file in your copy of

The following is the short guide, for a more detailled guide, see [Getting started](/getting-started).

- Copy the [template](https://github.com/rikhuijzer/JuliaTutorialsTemplate) by clicking on big "Use this template" button.
- Copy the [template](https://github.com/rikhuijzer/plutoTemplate) by clicking on big "Use this template" button.
- Replace the Pluto notebooks (`.jl` files) inside `tutorials` by your own tutorials.
- Change the menu at `layout/menu.html` to point to the right tutorials.
- Modify any text however you like, the source code has an MIT license.
Expand Down

0 comments on commit c49a959

Please sign in to comment.