README.md

docs.fyne.io Website

This repository contains the source of the https://docs.fyne.io website.

Running the website locally

The website uses jekyll to generate the website from markdown files. With ruby installed it is as easy as running the following commands in a terminal (the first only needs to run once):

Install jekyll

gem install bundler jekyll

Clone the Fyne docs repository

git clone https://github.com/fyne-io/docs.fyne.io.git

cd docs.fyne.io

Install dependencies

bundle install

Start the local webserver

bundle exec jekyll serve

Run generator scripts

To generate new images etc. you can use the following commands:

cd _gen
go run genwidgets.go # generate widget images
go run genlayouts.go # generate layout images
go run gendialogs.go # generate dialog images