How to Contribute

Would you like to help construct a language specification for Wolfram Language? It's as easy as clicking " Edit on GitHub" and writing some Markdown.

Just click on the index page of any category to find a place to start. If you have content but don't yet know where it should go, put it in the Homeless Content page.

Hit us up on...

  • Slack Workspace: https://wolfr.am/y0c73dZg
  • GitHub: https://github.com/WLTools Unfortunately, GitHub requires organization members to be "invited" by email or GitHub username, but I intend it to be open to anyone who wishes to participate. Hit us up on Slack.

Writing Content

If you do not yet have write access to this repository, you should use the usual GitHub workflow outlined below.

Get the Content

Fork the repository on GitHub. Then grab a local copy of your fork:

$ git clone git@github.com:yourusername/LanguageSpec.git

Writing

The content is written in Markdown files in a folder hierarchy in the docs directory. We have a style guide to help us write consistently. The style guide also explains how to typeset mathematics and other special content. If you add a file and want it to appear in the navigation menu, edit the mkdocs.yml file in the repository's root directory and include the file you want to add under nav following the existing examples.

Giving Back

Finally, commit and push your changes:

$ git commit -m "A meaningful commit message about the changes here."
$ git push origin master

Then create a pull request on GitHub. Done!

Modifying the Website Theme or Structure

You probably won't need to modify the theme or structure of the website. The site is statically generated with MkDocs. We use the built-in Read The Docs theme.

MkDocs is Python based, so we need a few pip install's. As usual, you will want to create a new Python 3 virtual environment. Then install MkDocs and a couple of libraries for code highlighting and Markdown extensions:

$ pip install mkdocs pygments pymdown-extensions markdown-include

If you haven't already, fork the repository on GitHub, and grab a local copy of your fork:

$ git clone git@github.com:yourusername/LanguageSpec.git

The left hand navigation is specified in the mkdocs.yml file.