Skip to content

Commit

Permalink
Merge pull request #19 from Emiller88/devcontainer
Browse files Browse the repository at this point in the history
Add devcontainer and instructions to build site
  • Loading branch information
kescobo committed Aug 11, 2023
2 parents 8ac2a60 + 96c0492 commit e31a78a
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 5 deletions.
21 changes: 21 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "biojulia.github.io",
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/julialang/devcontainer-features/julia:1": {
"channel": "release"
}
},
"customizations": {
"vscode": {
"extensions": [
"julialang.language-julia",
"tamasfe.even-better-toml",
"eamodio.gitlens"
]
}
},
"postCreateCommand": "julia --project=. -e 'using Pkg; Pkg.instantiate(); Pkg.precompile();'",
"postStartCommand": "julia --project=. -e 'using Xranklin; Xranklin.serve();'",
"forwardPorts": [8000]
}
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 e31a78a

Please sign in to comment.