Update documentation for usage and deployment #1906
Labels
documentation
Changes to documentation only (e.g., README, Guide, Wiki Pages, etc.)
Milestone
Comments
rjzupkoii
added
the
documentation
WillFuller
added a commit
to WillFuller/WillFuller.github.io
that referenced
this issue
May 10, 2024
# Merged changes from Upstream Fork * Increase font size in code blocks See academicpages#59 * Adds missing semi-colon * fix font awesome code icon in syntax box * Fix encoding issue with bib files * add goodreads to site * change orcid color * add medium icon * add medium profile * Resolve Google Scholar link not displayed There was as slight typo in the logic due to which the google scholar link for the respective author's profile set in Config was not being displayed. * Adding pronouns field to author profile * Add Google Analytics 4 Support * fix: Remove deprecated JavaScript to avoid load error from 404 page * Update files to be ignored * + webrick to gem file * academicpages#1902 RM excerpt in pages * Start updating the README * academicpages#456 Use real Google Scholar link as an example * Update issue templates * RM minimal mistakes changelog * academicpages#1906 * Edit readme * + Syntax highlighting example * Update README.md * Update README * Correct syntax * Streamline config organization for new users * Add Mastodon to social media * Closes academicpages#696 with new Kaggle link * Adjustments to Kaggle link * Closes academicpages#271 with addition of arXiv * academicpages#244, academicpages#1600, academicpages#1917 update font awesome to v6, add icons * Closes academicpages#1911 with update to Academicons * Closes academicpages#1671 with a new favicon * academicpages#462 update inline documentation * academicpages#1041 allow links to wrap * Closes academicpages#1773 with update to HTML * Closes academicpages#45 with an update to the CV generator * academicpages#33, academicpages#1919 Possible missing template fix, bump MathJax to 3.0 * academicpages#1153 add Zhihu * Closes academicpages#1905 with updates to documentation * Closes academicpages#693 with updates to documentation and location of citation * Closes academicpages#820 with updated style * added missing spanish translations and updated some of the previous ones on ui-text-yml * Replace `polyfill.io` * Closes academicpages#1972, update Markdown documentation * Closes academicpages#1936 with setting to hide RSS feed * academicpages#1935 clean-up the footer follow a bit * RM old development override * Make it clearer where the footnotes are * academicpages#1975 ignore files created by npm * Closes academicpages#339 with a fixed masthead * academicpages#1975 version updates, manage jQuery from npm * Closes academicpages#1970 with responsive element * Fix typo * Closes academicpages#1999 * scroll in sidebar * scroll in sidebar * Add scroll to sidebar and adjust media query for screen adaptability * Closes academicpages#2029 with update to sidebar * Closes academicpages#1917 with with icon, FA bump to 6.5.2 * Update _config.yml # Added More Info and blanked out the template filler material. * added to short left hand bio * Commented out most of the example publication * couldn't comment out the link, so changed text from The paper can be downloaded here to test link, and redirected the link to the correct test file * Comment out 2012-03-01-talk-1.md * Commented out 2013-03-01-tutorial-1.md * added some text so that the rest renders blank 2012-03-01-talk-1.md * Commented out 2014-02-01-talk-2.md * Comment out 2014-03-01-talk-3.md * Comment out 2012-08-14-blog-post-1.md * Update 2012-08-14-blog-post-1.md * Comment out Update 2199-01-01-future-post.md * Comment out portfolio-1.md * Comment out portfolio-2.html * Commented out pubs and talks for now navigation.yml * Update cv.md * Update cv.md * rename to about about.md * Update _config.yml * Rename webpage main title * Update cv.md - figured out how to properly comment out the links to stuff - added Scotts email - started to begin summary for each job * Update cv.md * Update cv.md * Create 2021-04-20-iop-poster-optimising.md * Update and rename 2021-04-20-iop-poster-optimising.md to 2021-04-06-iop-poster-optimising.md * added poster file * academicpages#2061 Update README with note on dependencies * Closes academicpages#2055 with adjustment to masthead-height * Adjust variable name to prevent confusion * Update casing of template name * managed to empty out the CV when stuff isn't there * hidden blogposts for now until I add some more * added some detail to CV * added some more intro details for the about page --------- ## Main Repo Credits Co-authored-by: Steve <[email protected]> Co-authored-by: Rob Williams <[email protected]> Co-authored-by: sigma67 <[email protected]> Co-authored-by: naveenarun <[email protected]> Co-authored-by: Mohit_Gupta <[email protected]> Co-authored-by: Bhavish Pahwa <[email protected]> Co-authored-by: amyzlc <[email protected]> Co-authored-by: Sonny Arora <[email protected]> Co-authored-by: Bhav Beri <[email protected]> Co-authored-by: rjzupkoii <[email protected]> Co-authored-by: johnhandleyd <[email protected]> Co-authored-by: SukkaW <[email protected]> Co-authored-by: Maximiliano <[email protected]>
WillFuller
added a commit
to WillFuller/WillFuller.github.io
that referenced
this issue
May 10, 2024
# Merged changes from Upstream Fork * Increase font size in code blocks See academicpages#59 * Adds missing semi-colon * fix font awesome code icon in syntax box * Fix encoding issue with bib files * add goodreads to site * change orcid color * add medium icon * add medium profile * Resolve Google Scholar link not displayed There was as slight typo in the logic due to which the google scholar link for the respective author's profile set in Config was not being displayed. * Adding pronouns field to author profile * Add Google Analytics 4 Support * fix: Remove deprecated JavaScript to avoid load error from 404 page * Update files to be ignored * + webrick to gem file * academicpages#1902 RM excerpt in pages * Start updating the README * academicpages#456 Use real Google Scholar link as an example * Update issue templates * RM minimal mistakes changelog * academicpages#1906 * Edit readme * + Syntax highlighting example * Update README.md * Update README * Correct syntax * Streamline config organization for new users * Add Mastodon to social media * Closes academicpages#696 with new Kaggle link * Adjustments to Kaggle link * Closes academicpages#271 with addition of arXiv * academicpages#244, academicpages#1600, academicpages#1917 update font awesome to v6, add icons * Closes academicpages#1911 with update to Academicons * Closes academicpages#1671 with a new favicon * academicpages#462 update inline documentation * academicpages#1041 allow links to wrap * Closes academicpages#1773 with update to HTML * Closes academicpages#45 with an update to the CV generator * academicpages#33, academicpages#1919 Possible missing template fix, bump MathJax to 3.0 * academicpages#1153 add Zhihu * Closes academicpages#1905 with updates to documentation * Closes academicpages#693 with updates to documentation and location of citation * Closes academicpages#820 with updated style * added missing spanish translations and updated some of the previous ones on ui-text-yml * Replace `polyfill.io` * Closes academicpages#1972, update Markdown documentation * Closes academicpages#1936 with setting to hide RSS feed * academicpages#1935 clean-up the footer follow a bit * RM old development override * Make it clearer where the footnotes are * academicpages#1975 ignore files created by npm * Closes academicpages#339 with a fixed masthead * academicpages#1975 version updates, manage jQuery from npm * Closes academicpages#1970 with responsive element * Fix typo * Closes academicpages#1999 * scroll in sidebar * scroll in sidebar * Add scroll to sidebar and adjust media query for screen adaptability * Closes academicpages#2029 with update to sidebar * Closes academicpages#1917 with with icon, FA bump to 6.5.2 * Update _config.yml # Added More Info and blanked out the template filler material. * added to short left hand bio * Commented out most of the example publication * couldn't comment out the link, so changed text from The paper can be downloaded here to test link, and redirected the link to the correct test file * Comment out 2012-03-01-talk-1.md * Commented out 2013-03-01-tutorial-1.md * added some text so that the rest renders blank 2012-03-01-talk-1.md * Commented out 2014-02-01-talk-2.md * Comment out 2014-03-01-talk-3.md * Comment out 2012-08-14-blog-post-1.md * Update 2012-08-14-blog-post-1.md * Comment out Update 2199-01-01-future-post.md * Comment out portfolio-1.md * Comment out portfolio-2.html * Commented out pubs and talks for now navigation.yml * Update cv.md * Update cv.md * rename to about about.md * Update _config.yml * Rename webpage main title * Update cv.md - figured out how to properly comment out the links to stuff - added Scotts email - started to begin summary for each job * Update cv.md * Update cv.md * Create 2021-04-20-iop-poster-optimising.md * Update and rename 2021-04-20-iop-poster-optimising.md to 2021-04-06-iop-poster-optimising.md * added poster file * academicpages#2061 Update README with note on dependencies * Closes academicpages#2055 with adjustment to masthead-height * Adjust variable name to prevent confusion * Update casing of template name * managed to empty out the CV when stuff isn't there * hidden blogposts for now until I add some more * added some detail to CV * added some more intro details for the about page --------- ## Main Repo Credits
aaronWool
pushed a commit
to aaronWool/aaronwool.github.io
that referenced
this issue
Jul 23, 2024
yoyolicoris
added a commit
to iamycy/iamycy.github.io
that referenced
this issue
Jul 27, 2024
* Increase font size in code blocks See academicpages#59 * Adds missing semi-colon * fix font awesome code icon in syntax box * Fix encoding issue with bib files * add goodreads to site * change orcid color * add medium icon * add medium profile * Resolve Google Scholar link not displayed There was as slight typo in the logic due to which the google scholar link for the respective author's profile set in Config was not being displayed. * Adding pronouns field to author profile * Add Google Analytics 4 Support * fix: Remove deprecated JavaScript to avoid load error from 404 page * Update files to be ignored * + webrick to gem file * academicpages#1902 RM excerpt in pages * Start updating the README * academicpages#456 Use real Google Scholar link as an example * Update issue templates * RM minimal mistakes changelog * academicpages#1906 * Edit readme * + Syntax highlighting example * Update README.md * Update README * Correct syntax * Streamline config organization for new users * Add Mastodon to social media * Closes academicpages#696 with new Kaggle link * Adjustments to Kaggle link * Closes academicpages#271 with addition of arXiv * academicpages#244, academicpages#1600, academicpages#1917 update font awesome to v6, add icons * Closes academicpages#1911 with update to Academicons * Closes academicpages#1671 with a new favicon * academicpages#462 update inline documentation * academicpages#1041 allow links to wrap * Closes academicpages#1773 with update to HTML * Closes academicpages#45 with an update to the CV generator * academicpages#33, academicpages#1919 Possible missing template fix, bump MathJax to 3.0 * academicpages#1153 add Zhihu * Closes academicpages#1905 with updates to documentation * Closes academicpages#693 with updates to documentation and location of citation * Closes academicpages#820 with updated style * added missing spanish translations and updated some of the previous ones on ui-text-yml * Replace `polyfill.io` * Closes academicpages#1972, update Markdown documentation * Closes academicpages#1936 with setting to hide RSS feed * academicpages#1935 clean-up the footer follow a bit * RM old development override * Make it clearer where the footnotes are * academicpages#1975 ignore files created by npm * Closes academicpages#339 with a fixed masthead * academicpages#1975 version updates, manage jQuery from npm * Closes academicpages#1970 with responsive element * Fix typo * Closes academicpages#1999 * scroll in sidebar * scroll in sidebar * Add scroll to sidebar and adjust media query for screen adaptability * Closes academicpages#2029 with update to sidebar * Closes academicpages#1917 with with icon, FA bump to 6.5.2 * academicpages#2061 Update README with note on dependencies * Closes academicpages#2055 with adjustment to masthead-height * Adjust variable name to prevent confusion * Update casing of template name * Fix typo in build-essential package name. The package which is required for this installation is named `build-essential`, not `build-essentials`. * Fix academicpages#1920 by allowing text to wrap * Add support to semantic scholar in author profile * Support for displaying slides on publication pages * Addressed PR academicpages#2126 review comments * Fix typo, modifications to style * Update _config.yml Make claimed default and actual default consistent * Add Chinese (both simplified and traditional) to ui-text.yml Simplified Chinese: zh zh-CN Traditional Chinese: zh-HK zh-TW * Adds commands for MacOS * Update README.md * update about me * use shorter QMUL * delete template file --------- Co-authored-by: Steve <[email protected]> Co-authored-by: Rob Williams <[email protected]> Co-authored-by: sigma67 <[email protected]> Co-authored-by: naveenarun <[email protected]> Co-authored-by: Mohit_Gupta <[email protected]> Co-authored-by: Bhavish Pahwa <[email protected]> Co-authored-by: amyzlc <[email protected]> Co-authored-by: Sonny Arora <[email protected]> Co-authored-by: Bhav Beri <[email protected]> Co-authored-by: rjzupkoii <[email protected]> Co-authored-by: johnhandleyd <[email protected]> Co-authored-by: SukkaW <[email protected]> Co-authored-by: Maximiliano <[email protected]> Co-authored-by: Dan Grahn <[email protected]> Co-authored-by: Dan Grahn <[email protected]> Co-authored-by: thiagorr162 <[email protected]> Co-authored-by: Saravanan D. <[email protected]> Co-authored-by: Manuel Haussmann <[email protected]> Co-authored-by: Yuhang YAN (Henry) <[email protected]> Co-authored-by: Zarela <[email protected]>
cabreraam
pushed a commit
to cabreraam/cabreraam.github.io
that referenced
this issue
Aug 24, 2024
yoyolicoris
added a commit
to iamycy/iamycy.github.io
that referenced
this issue
Oct 7, 2024
* Increase font size in code blocks See academicpages#59 * Adds missing semi-colon * fix font awesome code icon in syntax box * Fix encoding issue with bib files * add goodreads to site * change orcid color * add medium icon * add medium profile * Resolve Google Scholar link not displayed There was as slight typo in the logic due to which the google scholar link for the respective author's profile set in Config was not being displayed. * Adding pronouns field to author profile * Add Google Analytics 4 Support * fix: Remove deprecated JavaScript to avoid load error from 404 page * Update files to be ignored * + webrick to gem file * academicpages#1902 RM excerpt in pages * Start updating the README * academicpages#456 Use real Google Scholar link as an example * Update issue templates * RM minimal mistakes changelog * academicpages#1906 * Edit readme * + Syntax highlighting example * Update README.md * Update README * Correct syntax * Streamline config organization for new users * Add Mastodon to social media * Closes academicpages#696 with new Kaggle link * Adjustments to Kaggle link * Closes academicpages#271 with addition of arXiv * academicpages#244, academicpages#1600, academicpages#1917 update font awesome to v6, add icons * Closes academicpages#1911 with update to Academicons * Closes academicpages#1671 with a new favicon * academicpages#462 update inline documentation * academicpages#1041 allow links to wrap * Closes academicpages#1773 with update to HTML * Closes academicpages#45 with an update to the CV generator * academicpages#33, academicpages#1919 Possible missing template fix, bump MathJax to 3.0 * academicpages#1153 add Zhihu * Closes academicpages#1905 with updates to documentation * Closes academicpages#693 with updates to documentation and location of citation * Closes academicpages#820 with updated style * added missing spanish translations and updated some of the previous ones on ui-text-yml * Replace `polyfill.io` * Closes academicpages#1972, update Markdown documentation * Closes academicpages#1936 with setting to hide RSS feed * academicpages#1935 clean-up the footer follow a bit * RM old development override * Make it clearer where the footnotes are * academicpages#1975 ignore files created by npm * Closes academicpages#339 with a fixed masthead * academicpages#1975 version updates, manage jQuery from npm * Closes academicpages#1970 with responsive element * Fix typo * Closes academicpages#1999 * scroll in sidebar * scroll in sidebar * Add scroll to sidebar and adjust media query for screen adaptability * Closes academicpages#2029 with update to sidebar * Closes academicpages#1917 with with icon, FA bump to 6.5.2 * academicpages#2061 Update README with note on dependencies * Closes academicpages#2055 with adjustment to masthead-height * Adjust variable name to prevent confusion * Update casing of template name * Fix typo in build-essential package name. The package which is required for this installation is named `build-essential`, not `build-essentials`. * Fix academicpages#1920 by allowing text to wrap * Add support to semantic scholar in author profile * Support for displaying slides on publication pages * Addressed PR academicpages#2126 review comments * Fix typo, modifications to style * Update _config.yml Make claimed default and actual default consistent * Add Chinese (both simplified and traditional) to ui-text.yml Simplified Chinese: zh zh-CN Traditional Chinese: zh-HK zh-TW * Adds commands for MacOS * Update README.md * academicpages#2316 update padding * academicpages#2318 updating documentation a bit * Alphabetize the excludes * Closes academicpages#48 with a more general and customizable approach * fix: lastfm url * Update README.md * Fixing YouTube URL generation in author-profile.html YouTube does not use /user/username at the moment. If a person has a YouTube handle, the URL is: www.youtube.com/@HANDLE The fix is very minimal but I needed it for my website so I've also added it here. * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * academicpages#1975 cleaning up the gem files a bit * academicpages#1975 update fitvids to NPM * academicpages#1975 update magnific-popup to NPM * academicpages#1975 update smooth scroll to NPM * Closes academicpages#1975 RM stickyfill in favor of native browser support * Closes academicpages#2287, academicpages#534 with updates to documentation, better emoji generation * Add a dockerfile * Update README.md * bug: comments appear at bottom of page * Closes academicpages#146 with information the details HTML tag * Minor formatting * Closes academicpages#828 with update to put the pages last update in the footer. * academicpages#828 different format string * academicpages#828 adjustments to account for GitHub Pages limitations * Fix toc crop (academicpages#221) Fix by @qhuang-math. I have also removed underlining of toc links, which was being overridden by post body css. * Reduce excessive footer padding * Fix misalignment of navigation bar with post body There was a regression in the template updates where the navigation bar no longer aligns with the post left margin at normal viewport. * Add notebook to fetch publication information from orcid * Update author-profile.html improve alignment of "employer" sidebar * Closes academicpages#2469 with update to only use username * academicpages#1093 MV notebook to generator directory * Update Dockerfile --------- Co-authored-by: Steve <[email protected]> Co-authored-by: Rob Williams <[email protected]> Co-authored-by: sigma67 <[email protected]> Co-authored-by: naveenarun <[email protected]> Co-authored-by: Mohit_Gupta <[email protected]> Co-authored-by: Bhavish Pahwa <[email protected]> Co-authored-by: amyzlc <[email protected]> Co-authored-by: Sonny Arora <[email protected]> Co-authored-by: Bhav Beri <[email protected]> Co-authored-by: rjzupkoii <[email protected]> Co-authored-by: johnhandleyd <[email protected]> Co-authored-by: SukkaW <[email protected]> Co-authored-by: Maximiliano <[email protected]> Co-authored-by: Dan Grahn <[email protected]> Co-authored-by: Dan Grahn <[email protected]> Co-authored-by: thiagorr162 <[email protected]> Co-authored-by: Saravanan D. <[email protected]> Co-authored-by: Manuel Haussmann <[email protected]> Co-authored-by: Yuhang YAN (Henry) <[email protected]> Co-authored-by: Zarela <[email protected]> Co-authored-by: Yanchen Huang <[email protected]> Co-authored-by: edbrito-swdev <[email protected]> Co-authored-by: Alberto Barradas <[email protected]> Co-authored-by: Samir Rashid <[email protected]> Co-authored-by: Carlos Martinez <[email protected]> Co-authored-by: Xiaofei (Carl) Zang <[email protected]> Co-authored-by: Zoe <[email protected]>
austinwli
pushed a commit
to austinwli/austinwli.github.io
that referenced
this issue
Oct 13, 2024
Guancheng1
pushed a commit
to Guancheng1/Guancheng1.github.io
that referenced
this issue
Nov 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Since there have been changes to the underlying libraries, update the documentation to reflect these changes and make sure new users can easily use the template.
The text was updated successfully, but these errors were encountered: