Quick Start
test
Getting Started
Windows
Open Powershell in Admin mode
powershell -Command "Start-Process PowerShell -Verb RunAs"
Set the following environment variables:
$envName= 'psgist'
$envValue= '64e4d4d22d4757be6e8e26fd39d760c9'
$env:psgist = $envValue
function Set-EnvVar($envName, $envValue) {
# param($envName, $envValue)
# $env:$name = $value
[System.Environment]:: ($envName, $envValue,[System.EnvironmentVariableTarget]::User)
write-host 'Environment variable set'
write-host '$envName: $envValue'
}
Set-EnvVar $envName $envValue
echo $env:psgist
$name = "amr"
$value = "smells"
function Set-LocalVar($name, $value) {
# parm($name, $value)
write-host "$name $value"
}
Set-LocalVar amr smells
Navigate to Profile home directory
split-path $PROFILE | cd
Download $Profile
function Git-profile {
$gitUser ="bamr87"
Write-Output $env:psgist
$masterProfile = "Microsoft.PowerShell_profile.ps1"
$url = "https://gist.githubusercontent.com/$gitUser/$env:psgist/raw/$masterProfile"
$FileName = Split-Path $profile -Leaf
$FilePath = Split-Path $profile
$FullPath = "$FilePath\$FileName"
$webclient = New-Object System.Net.WebClient
$webclient.DownloadFile($url,$FullPath)
}
function Restart-Powershell {
Start-Process powershell
exit
}
restart powershell function
function Restart-Powershell {
Start-Process powershell
exit
}
Linux
MacOS
Importing and exporting homebrew packages
vscode://file/C:/Users/AmrAbdel-Motaleb/OneDrive/Documents/GitHub/_notes/Notes Index.md
{{site.github.repository_url}}
<div class="sidebar__top">
<a href="'''liquid{{site.github.repository_url}}'''/blob/gh-pages/{{page.name}}">
<i class="fab fa-github-square"></i>
</a>
<a href="vscode://file{{ site.local_git_pc}}/{{ site.local_repo }}/{{ page.path }}">
<i class="fas fa-laptop-code"></i>
</a>
<a href="vscode://file{{ site.local_git_mac}}/{{ site.local_repo }}/{{ page.path }}">
<i class="fas fa-laptop-code"></i>
</a>
<a href="#page-title" class="back-to-top">{{ site.data.ui-text[site.locale].back_to_top | default: 'Back to Top' }} ↑</a>
</div>
Features
Hover Notes
Paste images in Markdown
Autoscale images
Render LaTeX from markdown
add script to head
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
$$ \nabla_\boldsymbol{x} J(\boldsymbol{x}) $$
\(\nabla_\boldsymbol{x} J(\boldsymbol{x})\)
MathJax
Golden Ratio
1.6180339887
\phi = \frac{1+\sqrt{5}}{2}
\begin{equation} \phi = \frac{1+\sqrt{5}}{2} \end{equation}
\(\phi = \frac{1+\sqrt{5}}{2}\) is the golden ratio
\begin{align} \phi = \frac{1+\sqrt{5}}{2} \end{align}
Auto Name Code Snippet
# Conversion
markdown: kramdown
highlighter: rouge
syntax_highlighter: coderay
# lsi: false
# excerpt_separator: "\n\n"
# incremental: false
# Markdown Processing https://jekyllrb.com/docs/configuration/markdown/
kramdown: # https://kramdown.gettalong.org/options.html
input: GFM
header_offset: 2
# hard_wrap: false
auto_ids: true
# footnote_nr: 1
# entity_output: as_char
# toc_levels: 1..6
# smart_quotes: lsquo,rsquo,ldquo,rdquo
# enable_coderay: false
Keyboard shortcuts
Gallery
![this is a caption](../assets/images/nubi-son.png){: .img-fluid }
adding {: .img-fluid }
to a list of images will add it to the <p>
tag.
See _scss/it-journey/it-journey.scss
// Extends the CSS for .img-fluid to <img> tags inside a <p> tag
p, img
{
@extend .img-fluid;
}
Examples
this is a block quote
[!NOTE] this is a note
Welcome to MkDocs
For full documentation visit mkdocs.org.
Commands
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs -h
- Print help message and exit.
Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Icons with bootstrap
https://icons.getbootstrap.com/#install
OS Based instructions
TODO: find a way to include OS based instructions using liquid tags
These instructions are pertinent to Mac users.
These instructions are pertinent to Linux users.
These instructions are pertinent to Windows users.