Skip to content

Commit

Permalink
Deploying to gh-pages from @ 05d0d66 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@GiggleLiu
GiggleLiu committed Mar 1, 2024
1 parent 3681283 commit 21d50aa
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions workflow/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
<!doctype html> <html lang=en > <meta charset=UTF-8 > <meta name=viewport content="width=device-width, initial-scale=1"> <link rel=stylesheet href="/libs/highlight/styles/github.min.css"> <link rel=stylesheet href="/css/franklin.css"> <link rel=stylesheet href="/css/tufte.css"> <link rel=stylesheet href="/css/latex.css"> <link rel=stylesheet href="/css/adjust.css"> <link rel=icon href="/assets/favicon.png"> <title>Workflows</title> <div id=layout > <div id=menu > <ul> <li><a href="/">Home</a> <li><a href="/research/">Research</a> <li><a href="/people/">People</a> <li><a href="/phd/">PhD Program</a> <li><a href="/teaching/">Teaching</a> <li><a href="/culture/">Culture</a> </ul> </div> <div id=main > <div class=franklin-content ><h1 id=workflows ><a href="#workflows" class=header-anchor >Workflows</a></h1> <h2 id=git_linux_and_julia ><a href="#git_linux_and_julia" class=header-anchor >Git, Linux and Julia</a></h2> <p>The related tutorials are in the book <a href="https://book.jinguo-group.science">Scientific Computing for Physicists</a>. The following are the links to the tutorials:</p> <ul> <li><p><a href="https://book.jinguo-group.science/stable/chap1/terminal/">How to use Linux</a></p> <li><p><a href="https://book.jinguo-group.science/stable/chap1/git/">How to use Git</a></p> <li><p><a href="https://book.jinguo-group.science/stable/chap2/julia-setup/">Julia Installation Guide</a></p> </ul> <h2 id=github_copilot_markdown_for_technical_writing ><a href="#github_copilot_markdown_for_technical_writing" class=header-anchor >GitHub Copilot &#43; Markdown for technical writing</a></h2> <p>This is a workflow for setting up AI-assisted technical writing using Github Copilot and Markdown.</p> <h4 id=step_1_go_to_the_a_hrefhttpsgithubcomgithub_website_and_sign_up_for_a_free_account ><a href="#step_1_go_to_the_a_hrefhttpsgithubcomgithub_website_and_sign_up_for_a_free_account" class=header-anchor >Step 1: Go to the <a href="https://github.com/">GitHub website</a> and sign up for a free account.</a></h4> <h4 id=step_2_get_visual_studio_code_editor ><a href="#step_2_get_visual_studio_code_editor" class=header-anchor >Step 2: Get Visual Studio Code Editor</a></h4> <ol> <li><p>Go to <a href="https://code.visualstudio.com/">VS Code website</a> and download the latest version.</p> <li><p>Install &amp; open VS Code.</p> <li><p>Add the following VS Code extensions. To add an VS Code extension, please click the <code>Extensions</code> button in the left side bar, search for the extension name and click the <code>Install</code> button.</p> <ul> <li><p><a href="https://marketplace.visualstudio.com/items?itemName&#61;shd101wyy.markdown-preview-enhanced">Markdown Preview Enhanced</a></p> <li><p><a href="https://marketplace.visualstudio.com/items?itemName&#61;yzhang.markdown-all-in-one">Markdown All in One</a></p> </ul> <li><p>Create a new file and save it as <code>test.md</code>. Then, click the <code>Preview</code> button <img src=image-2.png alt="" />&#123;width&#61;20px&#125; in the top right corner.</p> <li><p>Edit the markdown file. You can learn markdown from <a href="https://www.markdownguide.org/basic-syntax/">here</a>. Math equations can also be rendered. For example, the following code $$ \frac{1}{2} $$ will be rendered as</p> </ol> <pre><code class=language-math >\frac&#123;1&#125;&#123;2&#125;</code></pre>
<ol start=2 >
<li><p>Install the following VS Code extension</p>
<ul>
<li><p><a href="https://marketplace.visualstudio.com/items?itemName&#61;GitHub.copilot">Github Copilot</a>. It requires you to connect with your Github account, and you can use it for free for 30 days. After 30 days, you can still use it for free but you need to join the waitlist. You can also use it for free if you are a student. You can apply for a student account <a href="https://education.github.com/pack">here</a>. Please check this <a href="https://youtu.be/HDG4PQK7DK8?si&#61;sOR7PqNcGAnrV4Tm">YouTube video</a> for more details</p>
<!doctype html> <html lang=en > <meta charset=UTF-8 > <meta name=viewport content="width=device-width, initial-scale=1"> <link rel=stylesheet href="/libs/highlight/styles/github.min.css"> <link rel=stylesheet href="/css/franklin.css"> <link rel=stylesheet href="/css/tufte.css"> <link rel=stylesheet href="/css/latex.css"> <link rel=stylesheet href="/css/adjust.css"> <link rel=icon href="/assets/favicon.png"> <title>Workflows</title> <div id=layout > <div id=menu > <ul> <li><a href="/">Home</a> <li><a href="/research/">Research</a> <li><a href="/people/">People</a> <li><a href="/phd/">PhD Program</a> <li><a href="/teaching/">Teaching</a> <li><a href="/culture/">Culture</a> </ul> </div> <div id=main > <div class=franklin-content ><h1 id=workflows ><a href="#workflows" class=header-anchor >Workflows</a></h1> <h2 id=git_linux_and_julia ><a href="#git_linux_and_julia" class=header-anchor >Git, Linux and Julia</a></h2> <p>The related tutorials are in the book <a href="https://book.jinguo-group.science">Scientific Computing for Physicists</a>. The following are the links to the tutorials:</p> <ul> <li><p><a href="https://book.jinguo-group.science/stable/chap1/terminal/">How to use Linux</a></p> <li><p><a href="https://book.jinguo-group.science/stable/chap1/git/">How to use Git</a></p> <li><p><a href="https://book.jinguo-group.science/stable/chap2/julia-setup/">Julia Installation Guide</a></p> </ul> <h2 id=github_copilot_markdown_for_technical_writing ><a href="#github_copilot_markdown_for_technical_writing" class=header-anchor >GitHub Copilot &#43; Markdown for technical writing</a></h2> <p>This is a workflow for setting up AI-assisted technical writing using Github Copilot and Markdown.</p> <h4 id=step_1_setup_markdown_editor ><a href="#step_1_setup_markdown_editor" class=header-anchor >Step 1: Setup Markdown Editor</a></h4> <ol> <li><p>Go to <a href="https://code.visualstudio.com/">VS Code website</a> and download the latest version, then install &amp; open VS Code.</p> <li><p>Add the following VS Code extensions. To add an VS Code extension, please click the <code>Extensions</code> button in the left side bar, search for the extension name and click the <code>Install</code> button.</p> <ul> <li><p><a href="https://marketplace.visualstudio.com/items?itemName&#61;shd101wyy.markdown-preview-enhanced">Markdown Preview Enhanced</a></p> <li><p><a href="https://marketplace.visualstudio.com/items?itemName&#61;yzhang.markdown-all-in-one">Markdown All in One</a></p> </ul> <li><p>Create a new file and save it as <code>test.md</code>. Then, click the <code>Preview</code> button <img src=image-2.png alt="" />&#123;width&#61;20px&#125; in the top right corner.</p> <li><p>Edit the markdown file. You can learn markdown from <a href="https://www.markdownguide.org/basic-syntax/">here</a>. Math equations can also be rendered. For example, the following code $$ \frac{1}{2} $$ will be rendered as</p> </ol> <pre><code class=language-math >\frac&#123;1&#125;&#123;2&#125;</code></pre>
<h4 id=step_2_setup_github_copilot ><a href="#step_2_setup_github_copilot" class=header-anchor >Step 2: Setup GitHub Copilot</a></h4>
<ol>
<li><p>Go to the <a href="https://github.com/">GitHub website</a> and sign up for a free account.</p>

</ul>
<li><p>Install the <a href="https://marketplace.visualstudio.com/items?itemName&#61;GitHub.copilot">GitHub Copilot</a> extension. GitHub Copilot requires you to connect with your Github account. You can also use it for free if you are a student &#40;<a href="https://education.github.com/pack">check out</a>&#41; or you will be charged for using it. Learn more from this <a href="https://youtu.be/HDG4PQK7DK8?si&#61;sOR7PqNcGAnrV4Tm">YouTube video</a>.</p>

<li><p>You might need to activate the Github Copilot extension by clicking the <code>Activate</code> &#40;<img src=image.png alt="" />&#123;width&#61;20px&#125;&#41; button in the bottom right corner of the VS Code window to make it work. Then you can type some text in the editor and press <code>Tab</code> to generate lecture notes.</p>
<li><p>You might need to activate the Github Copilot extension by clicking the <code>Activate</code> &#40;<img src=image.png alt="" />&#123;width&#61;20px&#125;&#41; button in the bottom right corner of the VS Code window to make it work. Then you can type some text in the editor and press <code>Tab</code> to confirm the suggestion from Github Copilot.</p>

</ol>
<h4 id=step_3_using_github_to_sync_your_files_optional ><a href="#step_3_using_github_to_sync_your_files_optional" class=header-anchor >Step 3: Using Github to sync your files &#40;optional&#41;</a></h4>
<p>If you want to sync your files across different devices, you can use Github. Github is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere. You can use Github to host your markdown files and provide preview.</p>
<p>This tutorial does not cover how to use Github. You can learn it from the <a href="https://www.youtube.com/watch?v&#61;RGOj5yH7evk">YouTube video</a> or the <a href="https://guides.github.com/activities/hello-world/">official guide</a>.</p>
<h4 id=step_3_using_github_to_host_your_markdown_optional ><a href="#step_3_using_github_to_host_your_markdown_optional" class=header-anchor >Step 3: Using Github to host your markdown &#40;optional&#41;</a></h4>
<p>Github is a code hosting platform for version control and collaboration. It allows you to</p>
<ul>
<li><p>sync files across different devices,</p>

<li><p>work together with others from anywhere, and</p>

<li><p>preview markdown files in the browser.</p>

</ul>
<p>You can learn GitHub from the <a href="https://www.youtube.com/watch?v&#61;RGOj5yH7evk">YouTube video</a> or the <a href="https://guides.github.com/activities/hello-world/">official guide</a>.</p>
<div class=page-foot >
<a href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a> GiggleLiu. Last modified: March 01, 2024.
Website built with <a href="https://github.com/tlienart/Franklin.jl">Franklin.jl</a> and the <a href="https://julialang.org">Julia programming language</a>.
Expand Down

0 comments on commit 21d50aa

Please sign in to comment.