Skip to content

Add more samples to the web site #162

@tpetricek

Description

@tpetricek

There is a couple of nice samples in the samples folder that are not currently on the web page. Adding a sample to the web page should be fairly easy and it is a fantastic way to learn Fable and contribute at the same time.

I recently added the D3 map and the commit is a good example of what needs to be done (it also does a few bug fixes you can ignore).

  • the d3map.fsx file is a good example of how to write docs (there are a few required things at the top)
  • in docs.fsx, you need to add the folder to the samples

And that is pretty much it - generally, follow what one of the other examples does. After modifying docs.fsx you can run:

./build.sh GenerateDocs
./build.sh BrowseDocs

The first will generate all docs (it compiles all samples, so do this just once). The second one starts local server and updates the samples when you change them. (On windows, use build.cmd)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions