https://github.com/farjs/farjs.github.io
Web site repo for FAR.js
https://github.com/farjs/farjs.github.io
farmanager filemanagement filemanager filemanager-ui
Last synced: 9 days ago
JSON representation
Web site repo for FAR.js
- Host: GitHub
- URL: https://github.com/farjs/farjs.github.io
- Owner: farjs
- License: mit
- Created: 2022-02-19T16:33:00.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-14T16:12:02.000Z (over 2 years ago)
- Last Synced: 2025-01-21T16:45:00.580Z (12 months ago)
- Topics: farmanager, filemanagement, filemanager, filemanager-ui
- Language: HTML
- Homepage: https://farjs.github.io
- Size: 112 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/farjs/farjs.github.io/actions/workflows/ci.yml?query=workflow%3Aci+branch%3Amain)
## FAR.js GitHub Pages
### Jekyll Theme
The site is built using the [jekyll-theme-slate](https://github.com/pages-themes/slate) theme.
### Previewing the site locally
If you'd like to preview the site locally (for example, in the process of proposing a change):
1. Clone down the site's repository (`git clone https://github.com/farjs/farjs.github.io`)
2. `cd` into the site's directory
3. Run `./script/bootstrap.sh` to install the necessary dependencies
4. Run `./script/server.sh` to start the preview server
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the site
### Running tests
The site contains a minimal test suite, to ensure a site with the theme would build successfully.
To run the tests, simply run `./script/cibuild.sh`.
You'll need to run `./script/bootstrap.sh` one before the test script will work.
### Markdown
Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
```markdown
Syntax highlighted code block
# Header 1
## Header 2
### Header 3
- Bulleted
- List
1. Numbered
2. List
**Bold** and _Italic_ and `Code` text
[Link](url) and 
```
For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
### How to embed draw.io Diagrams
[GitHub support](https://github.com/jgraph/drawio-github) is now available https://www.draw.io/?mode=github
An example for integration into GitHub wikis is available here [Embed Diagrams](https://github.com/jgraph/drawio/wiki/Embed-Diagrams)
Example diagrams are available [here](https://github.com/jgraph/drawio-diagrams)