Skip to content

Commit 6807fe5

Browse files
authored
add markdown generator info and document fix
1 parent 4528221 commit 6807fe5

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@ I think I've got things running smoothly and fixed some major bugs, but feel fre
1010
1. Set site-wide configuration and create content & metadata (see below -- also see [this set of diffs](http://archive.is/3TPas) showing what files were changed to set up [an example site](https://getorg-testacct.github.io) for a user with the username "getorg-testacct")
1111
1. Upload any files (like PDFs, .zip files, etc.) to the files/ directory. They will appear at https://[your GitHub username].github.io/files/example.pdf.
1212
1. Check status by going to the repository settings, in the "GitHub pages" section
13+
1. (Optional) Use the Jupyter notebooks or python scripts in the `markdown_generator` folder to generate markdown files for publications and talks from a TSV file.
1314

1415
See more info at https://academicpages.github.io/
1516

16-
# Bugs that have been fixed
17+
# Changelog -- bugfixes and enhancements
1718

1819
There is one logistical issue with a ready-to-fork template theme like academic pages that makes it a little tricky to get bug fixes and updates to the core theme. If you fork this repository, customize it, then pull again, you'll probably get merge conflicts. If you want to save your various .yml configuration files and markdown files, you can delete the repository and fork it again. Or you can manually patch.
1920

2021
To support this, here is a manually-curated list of bugs that have been fixed since this project was released. If you have a bug, you can go through and manually update. (If you have a better idea about how to support this, please let me know!)
2122

22-
- 2017-03-27: In author sidebar, link for Google Scholar displays site URL instead of Google Scholar URL in _config.yml. [Issue #6](https://github.com/academicpages/academicpages.github.io/issues/6), fixed in [34bg699](https://github.com/academicpages/academicpages.github.io/commit/34bd6990aa335c40cdadc01b5561797860d5eaa6)
23+
- 2017-03-27: In author sidebar, link for Google Scholar displays site URL instead of Google Scholar URL in _config.yml
24+
- [Issue #6](https://github.com/academicpages/academicpages.github.io/issues/6), fixed in [34bg699](https://github.com/academicpages/academicpages.github.io/commit/34bd6990aa335c40cdadc01b5561797860d5eaa6)
25+
- 2017-03-27: Markdown generator is now functioning properly and is well-documented, see the Jupyter notebooks in `markdown_generator`
26+
- [Issue #8](https://github.com/academicpages/academicpages.github.io/issues/8), fixed in [4528221](https://github.com/academicpages/academicpages.github.io/commit/4528221629bb93508c6ed149b9035d75bb38b402)

0 commit comments

Comments
 (0)