Skip to content

OmegaCombinator/acornprover.org

 
 

Repository files navigation

acornprover.org

The main website for the Acorn theorem prover.

The website is built with the Docusaurus framework, which is designed for documentation websites. It's pretty easy to add new documentation, or to edit the documentation - you're basically just editing Markdown files.

Please feel free to contribute pull requests! It's especially helpful to add documentation when you add new components to the standard library.

Where to put things

Description of the standard library goes into /docs/library.

Overall language documentation is in /docs/language or /docs/tutorial.

To write a blog post, add a markdown file in the /blog directory.

Testing it out

If you've made changes and want to see them locally, run:

npm install
npm start

To deploy to production, run:

npm run deploy

Autogenerating the library docs

acorn --lib ~/acornlib docs ./docs/library

Social cards

The social card is the image that gets included on social media when a page gets shared.

You can set the default social card for the site in the config, under themeConfig.image, and each blog post can also have its own image in its markdown.

The dimensions should be 1200 x 675 (landscape). 800 x 450 seems okay too. You can use Polacode or CodeSnap to make nice images of code. See examples/social-card.ac for an example. It's kind of awkward to get the image large enough. You might have to zoom in several times (six?), and then screen shot rather than save.

About

The main website for the Acorn theorem prover.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 38.5%
  • Python 32.7%
  • JavaScript 16.6%
  • CSS 12.2%