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-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,6 +79,8 @@ The **excerpt separator** `<!-- more -->` must be included, typically after the
79
79
80
80
**Images** should be placed in the same folder as the markdown file, and linked using markdown syntax, e.g. ``. By default, images are scaled to min(original size, text width), but this can look too large for high-res square images. In this case, use the classes `.img-tiny`, `.img-small`, `.img-medium` or `.img-large` to limit the maximum size, e.g. `{:.img-small}`.
81
81
82
+
To **publish** when you're happy with your post, push it to a branch on [draft-graphcore-research.github.io](https://github.com/graphcore-research/draft-graphcore-research.github.io) for review. When it's merged into `main`, push it to [graphcore-research.github.io](https://github.com/graphcore-research/graphcore-research.github.io), e.g. if the remotes are `public` and `origin`: `git push public origin/main:main`.
83
+
82
84
### POTM
83
85
84
86
Papers-of-the-month are special, consisting of a **root** page at `pages/posts/potm/YYYY/MM/potm.md`, and multiple **child** pages at `pages/posts/potm/YYYY/MM/paper-slug/paper-slug.md`. They should have specific frontmatter:
@@ -125,11 +127,11 @@ You can write a post as a notebook. It will not be executed by the build process
125
127
- The excerpt separator `<!-- more -->` must be included in a markdown cell near the top.
126
128
- All markdown features should work as they do for posts (e.g. relative links to images).
127
129
- By default **code cell content is not rendered**, only the outputs. There are two ways to render an individual cell's code: (a) use the "Add Tag" feature to add the cell tag "show_input" or (b) write `# SHOW_INPUT` on the first line (which will be stripped for display).
128
-
- If using exotic output formats, you may need to update the hook in [hooks/notebook_to_markdown.py](hooks/notebook_to_markdown.py).
130
+
- If using exotic output formats, you may need to update the hook in [hooks/render_notebook.py](hooks/render_notebook.py).
129
131
130
132
### Our Papers
131
133
132
-
To add a paper to the "Our Papers" page, add it to [pages/publications.data.yml](pages/publications.data.yml), as described in the file.
134
+
To add a paper to the "Our Papers" page, add it to [pages/.publications.yml](pages/.publications.yml), as described in the file.
133
135
134
136
### Hiring Banner
135
137
@@ -152,7 +154,7 @@ File/folder structure:
152
154
├── posts/potm/ # Papers of the month, with special handling ([hooks/merge_potm.py](hooks/merge_potm.py)) to merge children into root
153
155
├── .authors.yml # Author information, required for every author alias
154
156
├── .redirects.json # Generate redirects to keep old links working (by [hooks/generate_redirects.py](hooks/generate_redirects.py))
155
-
├── publications.md.j2 # "Our Papers" page template, rendered by [hooks/render_page_templates.py](hooks/render_page_templates.py)
157
+
├── publications.md.j2 # "Our Papers" page template, rendered by [hooks/render_page_template.py](hooks/render_page_template.py)
156
158
├── publications.data.yml # "Our Papers" data
157
159
├── *.md # Other standalone pages
158
160
├── site/ # Generated static site (after `mkdocs build`)
0 commit comments