adds info about drafts to readme

flatironinstitute · Jan 2, 2025 · fead90a · fead90a
1 parent 8fb15c8
commit fead90a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,10 @@ Website for Flatiron CCN's NeuroRSE group
 
 - The "Posts" section contains all the files from `site/_posts` whose names must
   be of the form `YYYY-MM-DD-title.md` in order to be included in the built site.
+- If you write a post that you do not want rendered yet, save it in the
+  `site/_drafts` folder. Then, to render it when building locally, add `--drafts` to
+  the `jekyll serve` command below to see it. When you are ready to include it
+  on the site, move it to the `site/_posts` folder.
 
 ## Building locally
 

diff --git a/site/_drafts/.gitkeep b/site/_drafts/.gitkeep