Added fix-whitespace.yaml and fixed whitespace.
This commit is contained in:
parent
a591bf8616
commit
f06137a621
15 changed files with 173 additions and 115 deletions
75
README.md
75
README.md
|
@ -4,47 +4,13 @@ title: Getting Started
|
||||||
permalink: /GettingStarted/
|
permalink: /GettingStarted/
|
||||||
---
|
---
|
||||||
|
|
||||||
<!-- Links -->
|
|
||||||
|
|
||||||
[epub]: https://plfa.github.io/out/epub/plfa.epub
|
|
||||||
[plfa]: http://plfa.inf.ed.ac.uk
|
|
||||||
[plfa-dev]: https://github.com/plfa/plfa.github.io/archive/dev.zip
|
|
||||||
[plfa-status]: https://travis-ci.org/plfa/plfa.github.io.svg?branch=dev
|
|
||||||
[plfa-travis]: https://travis-ci.org/plfa/plfa.github.io
|
|
||||||
[plfa-calver]: https://img.shields.io/badge/calver-20.07-22bfda
|
|
||||||
[plfa-latest]: https://github.com/plfa/plfa.github.io/releases/latest
|
|
||||||
[plfa-master]: https://github.com/plfa/plfa.github.io/archive/master.zip
|
|
||||||
|
|
||||||
[agda]: https://github.com/agda/agda/releases/tag/v2.6.1
|
|
||||||
[agda-version]: https://img.shields.io/badge/agda-v2.6.1-blue.svg
|
|
||||||
[agda-docs-emacs-mode]: https://agda.readthedocs.io/en/v2.6.1/tools/emacs-mode.html
|
|
||||||
[agda-docs-emacs-notation]: https://agda.readthedocs.io/en/v2.6.1/tools/emacs-mode.html#notation-for-key-combinations
|
|
||||||
[agda-docs-package-system]: https://agda.readthedocs.io/en/v2.6.1/tools/package-system.html#example-using-the-standard-library
|
|
||||||
|
|
||||||
[agda-stdlib-version]: https://img.shields.io/badge/agda--stdlib-v1.3-blue.svg
|
|
||||||
[agda-stdlib]: https://github.com/agda/agda-stdlib/releases/tag/v1.3
|
|
||||||
|
|
||||||
[haskell-stack]: https://docs.haskellstack.org/en/stable/README/
|
|
||||||
[haskell-ghc]: https://www.haskell.org/ghc/
|
|
||||||
|
|
||||||
[mononoki]: https://madmalik.github.io/mononoki/
|
|
||||||
|
|
||||||
[ruby]: https://www.ruby-lang.org/en/documentation/installation/
|
|
||||||
[ruby-bundler]: https://bundler.io/#getting-started
|
|
||||||
[ruby-jekyll]: https://jekyllrb.com/
|
|
||||||
[ruby-html-proofer]: https://github.com/gjtorikian/html-proofer
|
|
||||||
|
|
||||||
[kramdown]: https://kramdown.gettalong.org/syntax.html
|
|
||||||
[pandoc]: https://pandoc.org/installing.html
|
|
||||||
[epubcheck]: https://github.com/w3c/epubcheck
|
|
||||||
|
|
||||||
|
|
||||||
<!-- Status & Version Badges -->
|
<!-- Status & Version Badges -->
|
||||||
[![Calendar Version][plfa-calver]][plfa-latest]
|
[![Calendar Version][plfa-calver]][plfa-latest]
|
||||||
[![Build Status][plfa-status]][plfa-travis]
|
[![Build Status][plfa-status]][plfa-travis]
|
||||||
[![Agda][agda-version]][agda]
|
[![Agda][agda-version]][agda]
|
||||||
[![agda-stdlib][agda-stdlib-version]][agda-stdlib]
|
[![agda-stdlib][agda-stdlib-version]][agda-stdlib]
|
||||||
|
|
||||||
|
|
||||||
## Dependencies for users
|
## Dependencies for users
|
||||||
|
|
||||||
You can read PLFA [online][plfa] without installing anything.
|
You can read PLFA [online][plfa] without installing anything.
|
||||||
|
@ -174,8 +140,7 @@ You'll see the key sequence of the character in mini buffer.
|
||||||
|
|
||||||
## Dependencies for developers
|
## Dependencies for developers
|
||||||
|
|
||||||
PLFA is available as both a website and an EPUB e-book,
|
PLFA is available as both a website and an EPUB e-book, both of which can be built on Linux and macOS.
|
||||||
both of which can be built on Linux and macOS.
|
|
||||||
PLFA is written in literate Agda with [Kramdown Markdown][kramdown].
|
PLFA is written in literate Agda with [Kramdown Markdown][kramdown].
|
||||||
|
|
||||||
### Building the website
|
### Building the website
|
||||||
|
@ -195,7 +160,7 @@ Most recent versions of [Ruby][ruby] should work. The easiest way to install [Je
|
||||||
```bash
|
```bash
|
||||||
gem install bundler
|
gem install bundler
|
||||||
```
|
```
|
||||||
You can install the remainder of the dependencies---[Jekyll][ruby-jekyll], [html-proofer][ruby-html-proofer], *etc.*---by running:
|
You can install the remainder of the dependencies—[Jekyll][ruby-jekyll], [html-proofer][ruby-html-proofer], *etc.*—by running:
|
||||||
```bash
|
```bash
|
||||||
bundle install
|
bundle install
|
||||||
```
|
```
|
||||||
|
@ -234,3 +199,37 @@ Once you’ve installed Pandoc, you can build the EPUB by running:
|
||||||
make epub
|
make epub
|
||||||
```
|
```
|
||||||
The EPUB is written to `out/epub/plfa.epub`.
|
The EPUB is written to `out/epub/plfa.epub`.
|
||||||
|
|
||||||
|
<!-- Links -->
|
||||||
|
|
||||||
|
[epub]: https://plfa.github.io/out/epub/plfa.epub
|
||||||
|
[plfa]: http://plfa.inf.ed.ac.uk
|
||||||
|
[plfa-dev]: https://github.com/plfa/plfa.github.io/archive/dev.zip
|
||||||
|
[plfa-status]: https://travis-ci.org/plfa/plfa.github.io.svg?branch=dev
|
||||||
|
[plfa-travis]: https://travis-ci.org/plfa/plfa.github.io
|
||||||
|
[plfa-calver]: https://img.shields.io/badge/calver-20.07-22bfda
|
||||||
|
[plfa-latest]: https://github.com/plfa/plfa.github.io/releases/latest
|
||||||
|
[plfa-master]: https://github.com/plfa/plfa.github.io/archive/master.zip
|
||||||
|
|
||||||
|
[agda]: https://github.com/agda/agda/releases/tag/v2.6.1
|
||||||
|
[agda-version]: https://img.shields.io/badge/agda-v2.6.1-blue.svg
|
||||||
|
[agda-docs-emacs-mode]: https://agda.readthedocs.io/en/v2.6.1/tools/emacs-mode.html
|
||||||
|
[agda-docs-emacs-notation]: https://agda.readthedocs.io/en/v2.6.1/tools/emacs-mode.html#notation-for-key-combinations
|
||||||
|
[agda-docs-package-system]: https://agda.readthedocs.io/en/v2.6.1/tools/package-system.html#example-using-the-standard-library
|
||||||
|
|
||||||
|
[agda-stdlib-version]: https://img.shields.io/badge/agda--stdlib-v1.3-blue.svg
|
||||||
|
[agda-stdlib]: https://github.com/agda/agda-stdlib/releases/tag/v1.3
|
||||||
|
|
||||||
|
[haskell-stack]: https://docs.haskellstack.org/en/stable/README/
|
||||||
|
[haskell-ghc]: https://www.haskell.org/ghc/
|
||||||
|
|
||||||
|
[mononoki]: https://madmalik.github.io/mononoki/
|
||||||
|
|
||||||
|
[ruby]: https://www.ruby-lang.org/en/documentation/installation/
|
||||||
|
[ruby-bundler]: https://bundler.io/#getting-started
|
||||||
|
[ruby-jekyll]: https://jekyllrb.com/
|
||||||
|
[ruby-html-proofer]: https://github.com/gjtorikian/html-proofer
|
||||||
|
|
||||||
|
[kramdown]: https://kramdown.gettalong.org/syntax.html
|
||||||
|
[pandoc]: https://pandoc.org/installing.html
|
||||||
|
[epubcheck]: https://github.com/w3c/epubcheck
|
||||||
|
|
60
fix-whitespace.yaml
Normal file
60
fix-whitespace.yaml
Normal file
|
@ -0,0 +1,60 @@
|
||||||
|
# This file contains the project-specific settings for `fix-whitespace` a tiny
|
||||||
|
# but useful tool to
|
||||||
|
#
|
||||||
|
# * Removes trailing whitespace.
|
||||||
|
# * Removes trailing lines containing nothing but whitespace.
|
||||||
|
# * Ensures that the file ends in a newline character.
|
||||||
|
#
|
||||||
|
# By default, fix-whitespace checks every directory under the current working
|
||||||
|
# directory but no files. This program should be placed under a text-based
|
||||||
|
# project.
|
||||||
|
#
|
||||||
|
# For directories,
|
||||||
|
#
|
||||||
|
# 1) excluded-dirs is a black-list of directories,
|
||||||
|
# 2) included-dirs is a white-list of excluded-dirs
|
||||||
|
#
|
||||||
|
# For files,
|
||||||
|
#
|
||||||
|
# 3) included-files is a white-list of files,
|
||||||
|
# 4) excluded-files is a black-list of included-files.
|
||||||
|
#
|
||||||
|
# The extended glob pattern can be used to specify file/direcotory names.
|
||||||
|
# For details, see http://hackage.haskell.org/package/filemanip-0.3.6.3/docs/System-FilePath-GlobPattern.html
|
||||||
|
#
|
||||||
|
included-dirs:
|
||||||
|
- "src"
|
||||||
|
- "epub"
|
||||||
|
- "_includes"
|
||||||
|
- "_layouts"
|
||||||
|
- "_posts"
|
||||||
|
- "_sass"
|
||||||
|
- "_assets"
|
||||||
|
- "courses"
|
||||||
|
- "papers"
|
||||||
|
|
||||||
|
excluded-dirs:
|
||||||
|
- ".stack-work"
|
||||||
|
- ".git"
|
||||||
|
- "_build"
|
||||||
|
- "_site"
|
||||||
|
- "extra"
|
||||||
|
- "tmp"
|
||||||
|
|
||||||
|
# Every matched filename is included unless it is matched by excluded-files.
|
||||||
|
included-files:
|
||||||
|
- "*.md"
|
||||||
|
- "*.sh"
|
||||||
|
- "*.html"
|
||||||
|
- "*.yml"
|
||||||
|
- "*.yaml"
|
||||||
|
- "*.agda-lib"
|
||||||
|
- "Gemfile"
|
||||||
|
- "Guardfile"
|
||||||
|
- "LICENSE"
|
||||||
|
|
||||||
|
excluded-files:
|
||||||
|
- "*.sed"
|
||||||
|
- ".DS_Store"
|
||||||
|
- "Gemfile.lock"
|
||||||
|
- "Makefile"
|
|
@ -4,4 +4,3 @@ layout : home
|
||||||
permalink : /Announcements/
|
permalink : /Announcements/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue