You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
This repository holds the [Automerge website](https://automerge.org), including all the docs, blog posts, and other site **content**, the **templates** that give pages their structure and styling, and a custom build **system** that weaves it all together.
4
4
5
+
We welcome all contributions. If you see any mistakes or glitches on the website, or have any trouble building the site locally, please [file an issue](https://github.com/automerge/website/issues) or [open a pull request](https://github.com/automerge/website/pulls). Thank you.
6
+
5
7
<br><br>
6
8
7
9
# Getting Started
@@ -15,12 +17,6 @@ Henceforth:
15
17
16
18
> If `site` doesn't work, use `./site` instead (or add `.` to your $PATH)
17
19
18
-
<br>
19
-
20
-
### Contributions & Issues
21
-
22
-
If you see any issues with the website, or have any trouble running the build system yourself, please [file an issue](https://github.com/automerge/website/issues).
23
-
24
20
<br><br>
25
21
26
22
# Documentation
@@ -45,17 +41,18 @@ If you see any issues with the website, or have any trouble running the build sy
45
41
Here's the folder structure:
46
42
47
43
*`content` — html and markdown files for every page, plus a few lightweight assets; see [pages](#pages)
48
-
*`demo` — source files for the interactive demo on the home page.
44
+
*`demo` — source files for the interactive demo on the home page
49
45
*`fonts` — uncompressed source files for fonts used on the site; see [fonts](#fonts)
50
46
*`public` — automatically generated when building the site
51
47
*`system` — the build system source code; see [system](#system)
52
48
*`template` — html files that define different types of page on the site; see [templates](#templates)
49
+
*`Redirects.txt` — Cool URIs don't change; see [redirects](#redirects)
53
50
54
51
This site is powered by our own custom build system, which we can adapt and extend as our needs change.
55
52
56
53
The build system takes HTML and Markdown files in the `content` folder, parses and transforms them with rules defined in `system`, combines the result with various templates in `template`, and finally saves the fully-assembled page to `public`.
57
54
58
-
In short, the `content` folder should feel like an FTP server. You put stuff in there, and it shows up on the website. The file path becomes the URL. There's more, of course — macros and templates and other behaviour that we'll get to in a second. But all that fanciness is *opt-in*. If you stick to plain HTML and simple assets, `/content`acts just like FTP.
55
+
In short, the `content` folder should feel like an FTP server. You put stuff in there, and it shows up on the website. The file path becomes the URL. There's more, of course — macros and templates and other behaviour that we'll get to in a second. But all that fanciness is *opt-in*. If you stick to plain HTML and simple assets, `/content`feels just like FTP.
0 commit comments