Skip to content

Commit

Permalink
docs: Add instructions to build the site
Browse files Browse the repository at this point in the history
  • Loading branch information
edmundmiller committed Aug 10, 2023
1 parent 92400a2 commit 96c0492
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,22 @@

[![Website URL badge](https://img.shields.io/badge/site-BioJulia.dev-blue)](https://biojulia.dev)

## Development

### Building the site

## Static Site Tech
The project devcontainer can be used. Check out [Get started with development Containers in Visual Studio Code](https://code.visualstudio.com/docs/devcontainers/tutorial) if you're not familar with devcontainers.

Using [Xranklin](https://github.com/tlienart/Xranklin.jl) under the hood.
Otherwise you can quickly build the site with the following commands:

### Celeste Template
```julia
julia> using Pkg; Pkg.instantiate(); Pkg.precompile();
julia> using Xranklin; Xranklin.serve();
```

Based on the wonderful [Celeste](https://github.com/nicoelayda/celeste) by @nicoelayda.
The LiveServer will begin listening on http://localhost:8000/ !

#### Development
### CSS

Any changes to the CSS should be made to the SCSS files in `_sass/` and compiled using `Sass.jl` as follows:

Expand All @@ -21,3 +26,11 @@ Sass.compile_file("style.scss", "../_css/celeste.min.css"; output_style = Sass.c
```

All the `Franklin.jl` related changes are in `_sass/adjust.scss`

## Static Site Tech

Using [Xranklin](https://github.com/tlienart/Xranklin.jl) under the hood.

### Celeste Template

Based on the wonderful [Celeste](https://github.com/nicoelayda/celeste) by @nicoelayda.

0 comments on commit 96c0492

Please sign in to comment.