Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
vituri committed May 27, 2024
1 parent 14360cd commit 70eba3a
Show file tree
Hide file tree
Showing 7 changed files with 760 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
d13d5e0a
27e76c62
55 changes: 55 additions & 0 deletions search.json
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,61 @@
"Tutorials"
]
},
{
"objectID": "tutorials/tutorial-02.html",
"href": "tutorials/tutorial-02.html",
"title": "Adding content",
"section": "",
"text": "After the first tutorial, we have a basic Quarto website running. But what if we want to add more things?\n\n\nAt the start of every .qmd file you create, add the lines\n\n---\nengine: julia\n---\n\n\nso Quarto will use the julia engine (and not the jupyter one).\n\n\n\nAll .qmd files in the docs/tutorials folder will be rendered and put together on the Tutorials tab. If you want more control over which .qmd files will be rendered and in which order, you will need to edit the file docs/_quarto.yaml. See more details at the Quarto official documentation.\nIn TidierIteration.jl, I added the following files\n\nwhich rendered as follows\n\n\n\n\nIf you kept developing your package and added more functions (or modified some existent ones), it is a good idea to remake all .qmd files on the docs/reference/ folder. To do that, activate the docs/ environment like in the previous tutorial and run the following:\n\nusing .TidierIteration\nusing QuartoDocBuilder\n\nobjs = get_objects_from_module(module_name)\nobjs .|> quarto_doc_page\n\nThis can also be written in the docs/make.jl file. If you want to rewrite the docs/reference.qmd file, add the following line:\n\nquarto_build_refpage(TidierIteration)\n\nBe careful: this will overwrite your current docs/reference.qmd file! In case you want to write the content of this file into another file, pass the optional argument output:\n\nquarto_build_refpage(TidierIteration, output = \"docs/reference2.qmd\")\n\n\n\n\nAll this can be done by modifying the docs/_quarto.yaml file. Learn how to do it here. For example, here are different ways to navigate in your site, changing the header and so on.",
"crumbs": [
"Tutorials",
"Adding content"
]
},
{
"objectID": "tutorials/tutorial-02.html#the-julia-engine",
"href": "tutorials/tutorial-02.html#the-julia-engine",
"title": "Adding content",
"section": "",
"text": "At the start of every .qmd file you create, add the lines\n\n---\nengine: julia\n---\n\n\nso Quarto will use the julia engine (and not the jupyter one).",
"crumbs": [
"Tutorials",
"Adding content"
]
},
{
"objectID": "tutorials/tutorial-02.html#adding-tutorials",
"href": "tutorials/tutorial-02.html#adding-tutorials",
"title": "Adding content",
"section": "",
"text": "All .qmd files in the docs/tutorials folder will be rendered and put together on the Tutorials tab. If you want more control over which .qmd files will be rendered and in which order, you will need to edit the file docs/_quarto.yaml. See more details at the Quarto official documentation.\nIn TidierIteration.jl, I added the following files\n\nwhich rendered as follows",
"crumbs": [
"Tutorials",
"Adding content"
]
},
{
"objectID": "tutorials/tutorial-02.html#adding-more-function-to-the-reference-page",
"href": "tutorials/tutorial-02.html#adding-more-function-to-the-reference-page",
"title": "Adding content",
"section": "",
"text": "If you kept developing your package and added more functions (or modified some existent ones), it is a good idea to remake all .qmd files on the docs/reference/ folder. To do that, activate the docs/ environment like in the previous tutorial and run the following:\n\nusing .TidierIteration\nusing QuartoDocBuilder\n\nobjs = get_objects_from_module(module_name)\nobjs .|> quarto_doc_page\n\nThis can also be written in the docs/make.jl file. If you want to rewrite the docs/reference.qmd file, add the following line:\n\nquarto_build_refpage(TidierIteration)\n\nBe careful: this will overwrite your current docs/reference.qmd file! In case you want to write the content of this file into another file, pass the optional argument output:\n\nquarto_build_refpage(TidierIteration, output = \"docs/reference2.qmd\")",
"crumbs": [
"Tutorials",
"Adding content"
]
},
{
"objectID": "tutorials/tutorial-02.html#creating-more-tabs-adjusting-the-layout-and-so-on",
"href": "tutorials/tutorial-02.html#creating-more-tabs-adjusting-the-layout-and-so-on",
"title": "Adding content",
"section": "",
"text": "All this can be done by modifying the docs/_quarto.yaml file. Learn how to do it here. For example, here are different ways to navigate in your site, changing the header and so on.",
"crumbs": [
"Tutorials",
"Adding content"
]
},
{
"objectID": "reference.html",
"href": "reference.html",
Expand Down
6 changes: 6 additions & 0 deletions tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,12 @@
<a href="./tutorials/tutorial-01.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">From zero to nice docs!</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./tutorials/tutorial-02.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Adding content</span></a>
</div>
</li>
</ul>
</div>
Expand Down
10 changes: 10 additions & 0 deletions tutorials/tutorial-01.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<script src="../site_libs/quarto-search/fuse.min.js"></script>
<script src="../site_libs/quarto-search/quarto-search.js"></script>
<meta name="quarto:offset" content="../">
<link href="../tutorials/tutorial-02.html" rel="next">
<link href="../tutorials.html" rel="prev">
<script src="../site_libs/quarto-html/quarto.js"></script>
<script src="../site_libs/quarto-html/popper.min.js"></script>
Expand Down Expand Up @@ -164,6 +165,12 @@
<a href="../tutorials/tutorial-01.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">From zero to nice docs!</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../tutorials/tutorial-02.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Adding content</span></a>
</div>
</li>
</ul>
</div>
Expand Down Expand Up @@ -733,6 +740,9 @@ <h2 class="anchored" data-anchor-id="next-steps">Next steps</h2>
</a>
</div>
<div class="nav-page nav-page-next">
<a href="../tutorials/tutorial-02.html" class="pagination-link" aria-label="Adding content">
<span class="nav-page-text">Adding content</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
</div> <!-- /content -->
Expand Down
Binary file added tutorials/tutorial-02-files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorials/tutorial-02-rendered.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 70eba3a

Please sign in to comment.