https://github.com/quantumbfs/quantumbfs.github.io
Homepage of the organization. Discussion about this organization should be in this repo's issue list.
https://github.com/quantumbfs/quantumbfs.github.io
Last synced: about 1 year ago
JSON representation
Homepage of the organization. Discussion about this organization should be in this repo's issue list.
- Host: GitHub
- URL: https://github.com/quantumbfs/quantumbfs.github.io
- Owner: QuantumBFS
- Created: 2018-04-13T14:01:17.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T05:16:36.000Z (over 3 years ago)
- Last Synced: 2025-02-16T02:41:16.736Z (over 1 year ago)
- Language: Julia
- Homepage: http://yaoquantum.org/
- Size: 5.99 MB
- Stars: 2
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is the GitHub repository for the Yao Framework's main website, [yaoquantum.org](https://yaoquantum.org).
The Yao website is generated using GitHub pages and [Franklin.jl](https://github.com/tlienart/Franklin.jl), a Julia native package for building static websites.
## Making Simple Changes
To suggest a change to the website, you can simply navigate to the page with the content you think should be changed, and edit it.
You will be prompted to fork the repo (if you haven't already) and then open a Pull Request.
Once your Pull Request is merged, you should see your changes show up on the website in a few minutes or less.
Build previews for each Pull Request will be linked in the comment section of the PR once the site has been successfully build.
**Note**: please only use _fenced_ code blocks (i.e. code blocks delimited by backticks) and not indented code blocks.
## Making modifications and seeing the changes locally
Clone the repository and `cd` to it. Start julia with `julia --project` and do
```julia
julia> using Pkg; Pkg.instantiate()
julia> using Franklin
julia> serve()
→ Initial full pass...
→ evaluating code [...] (learning/code-examples.md)
→ Starting the server...
✓ LiveServer listening on https://localhost:8000/ ...
(use CTRL+C to shut down)
```
Navigate to `localhost:8000` in a browser and you should see a preview of any modifications you make locally.
**Modifying the CSS**: modify the relevant files in `_css/`.
**Modifying the HTML structure**: if you want to modify the navbar, or the footer, go to `_layout/` and modify the relevant template fragment.
**Modifying the landing page**: since the landing page has its own design, it is written in HTML with a few insertions of repurposeable fragments where appropriate, just modify `index.html`