Skip to content

Commit

Permalink
fix code and li styling and escape some unintentional italicization i…
Browse files Browse the repository at this point in the history
…n quickstart
  • Loading branch information
RyanBrewer317 committed Oct 21, 2024
1 parent 081e059 commit c48f076
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 12 deletions.
1 change: 1 addition & 0 deletions .arctic_cache.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
"guides/quickstart.txt","d6iaZ5Ts4mJlITSYzX8i8lRU6IuZDE5wzM4TJX/r6PU","id:quickstart","title:Quickstart","tags:quick,start,simple,started","blerb:Getting started with a simple Arctic website."
"guides/quickstart.txt","dTL4OgmkmRaUDFthCBC+Y1eJZMxlXDs6n2vJQMtcVCk","id:quickstart","title:Quickstart","tags:quick,start,simple,started","blerb:Getting started with a simple Arctic website."
"guides/quickstart.txt","U6ZHt9LEk/lnowBR5y/eNfabaDVJyvo6aGxQ3QOCq1c","id:quickstart","title:Quickstart","tags:quick,start,simple,started","blerb:Getting started with a simple Arctic website."
"guides/quickstart.txt","mlvrrFwYMuHKdUpCIvHFasJxjcuC9FYxS8kpk4ksNcM","id:quickstart","title:Quickstart","tags:quick,start,simple,started","blerb:Getting started with a simple Arctic website."
6 changes: 3 additions & 3 deletions arctic_build/__pages/guides/quickstart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
When you run <code><span>gleam run</span></code>,
you will find your site in the new <code><span>arctic_build/</span></code> directory.
<code><span>arctic_build/index.html</span></code> might be hard to understand because of Arctic&#39;s optimization,
but <code><span>arctic_build/<em><span></span></em>pages/index.html</span></code> should hopefully look more familiar.
but <code><span>arctic_build/__pages/index.html</span></code> should hopefully look more familiar.
</span></p><h3><span>Next Steps
</span></h3><p><span>I don&#39;t usually deploy from <code><span>arctic_build/</span></code> directly.
I typically use a build script that copies the contents
Expand All @@ -83,7 +83,7 @@
<a href="https://ryanbrewer.dev"><span>ryanbrewer.dev</span></a> is an even bigger example,
and has <a href="https://github.com/RyanBrewer317/ryanbrewer-dev"><span>licensed code</span></a>.
</span></p><p><span>You might run into difficulties with Arctic&#39;s routing in the beginning.
The easiest solution is to add <code><span>|&gt; config.turn<em><span>off</span></em>spa()</span></code> to your <code><span>main</span></code> function.
The easiest solution is to add <code><span>|&gt; config.turn_off_spa()</span></code> to your <code><span>main</span></code> function.
A much better solution, though, is to instead
get your hosting provider to send all requests to <code><span>/index.html</span></code>.
If you&#39;re using Firebase Hosting,
Expand All @@ -96,7 +96,7 @@
]
</code></pre><p><span>This allows Arctic to handle routing and potentially speed up your website.
If you want to use SPA tricks like non-rerendering internal links, you&#39;ll have to do this.
Arctic offers the <code><span>|&gt; config.add<em><span>spa</span></em>frame(f)</span></code> option for this purpose,
Arctic offers the <code><span>|&gt; config.add_spa_frame(f)</span></code> option for this purpose,
and you can see how this site uses it to avoid rerendering the navigation bar.
</span></p><p><span>I also use the build script to copy javascript
that I compiled from client-side gleam code into <code><span>dist/</span></code>.
Expand Down
6 changes: 5 additions & 1 deletion arctic_build/public/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ nav.dropdown {
}
}

p {
p, li {
line-height: 25pt;
}

Expand All @@ -73,6 +73,10 @@ code::-webkit-scrollbar { /* Chrome, Safari */
display: none;
}

pre code {
display: block;
}

#arctic-app {
padding: 12pt;
max-width: 600pt;
Expand Down
6 changes: 3 additions & 3 deletions dist/__pages/guides/quickstart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
When you run <code><span>gleam run</span></code>,
you will find your site in the new <code><span>arctic_build/</span></code> directory.
<code><span>arctic_build/index.html</span></code> might be hard to understand because of Arctic&#39;s optimization,
but <code><span>arctic_build/<em><span></span></em>pages/index.html</span></code> should hopefully look more familiar.
but <code><span>arctic_build/__pages/index.html</span></code> should hopefully look more familiar.
</span></p><h3><span>Next Steps
</span></h3><p><span>I don&#39;t usually deploy from <code><span>arctic_build/</span></code> directly.
I typically use a build script that copies the contents
Expand All @@ -83,7 +83,7 @@
<a href="https://ryanbrewer.dev"><span>ryanbrewer.dev</span></a> is an even bigger example,
and has <a href="https://github.com/RyanBrewer317/ryanbrewer-dev"><span>licensed code</span></a>.
</span></p><p><span>You might run into difficulties with Arctic&#39;s routing in the beginning.
The easiest solution is to add <code><span>|&gt; config.turn<em><span>off</span></em>spa()</span></code> to your <code><span>main</span></code> function.
The easiest solution is to add <code><span>|&gt; config.turn_off_spa()</span></code> to your <code><span>main</span></code> function.
A much better solution, though, is to instead
get your hosting provider to send all requests to <code><span>/index.html</span></code>.
If you&#39;re using Firebase Hosting,
Expand All @@ -96,7 +96,7 @@
]
</code></pre><p><span>This allows Arctic to handle routing and potentially speed up your website.
If you want to use SPA tricks like non-rerendering internal links, you&#39;ll have to do this.
Arctic offers the <code><span>|&gt; config.add<em><span>spa</span></em>frame(f)</span></code> option for this purpose,
Arctic offers the <code><span>|&gt; config.add_spa_frame(f)</span></code> option for this purpose,
and you can see how this site uses it to avoid rerendering the navigation bar.
</span></p><p><span>I also use the build script to copy javascript
that I compiled from client-side gleam code into <code><span>dist/</span></code>.
Expand Down
6 changes: 5 additions & 1 deletion dist/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ nav.dropdown {
}
}

p {
p, li {
line-height: 25pt;
}

Expand All @@ -73,6 +73,10 @@ code::-webkit-scrollbar { /* Chrome, Safari */
display: none;
}

pre code {
display: block;
}

#arctic-app {
padding: 12pt;
max-width: 600pt;
Expand Down
6 changes: 3 additions & 3 deletions guides/quickstart.txt
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ and construct a website from it.
When you run `gleam run`,
you will find your site in the new `arctic_build/` directory.
`arctic_build/index.html` might be hard to understand because of Arctic's optimization,
but `arctic_build/__pages/index.html` should hopefully look more familiar.
but `arctic\_build/\_\_pages/index.html` should hopefully look more familiar.

### Next Steps

Expand All @@ -115,7 +115,7 @@ It should give you ideas for how to extend your parser and add new pages.
and has [licensed code](https://github.com/RyanBrewer317/ryanbrewer-dev).

You might run into difficulties with Arctic's routing in the beginning.
The easiest solution is to add `|> config.turn_off_spa()` to your `main` function.
The easiest solution is to add `|> config.turn\_off\_spa()` to your `main` function.
A much better solution, though, is to instead
get your hosting provider to send all requests to `/index.html`.
If you're using Firebase Hosting,
Expand All @@ -131,7 +131,7 @@ you can do this by adding a `rewrites` section to your `firebase.json`:

This allows Arctic to handle routing and potentially speed up your website.
If you want to use SPA tricks like non-rerendering internal links, you'll have to do this.
Arctic offers the `|> config.add_spa_frame(f)` option for this purpose,
Arctic offers the `|> config.add\_spa\_frame(f)` option for this purpose,
and you can see how this site uses it to avoid rerendering the navigation bar.

I also use the build script to copy javascript
Expand Down
6 changes: 5 additions & 1 deletion public/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ nav.dropdown {
}
}

p {
p, li {
line-height: 25pt;
}

Expand All @@ -73,6 +73,10 @@ code::-webkit-scrollbar { /* Chrome, Safari */
display: none;
}

pre code {
display: block;
}

#arctic-app {
padding: 12pt;
max-width: 600pt;
Expand Down

0 comments on commit c48f076

Please sign in to comment.