ABOUT THIS WIKI

• How I maintain this wiki
  • Structure of pages
  • Software Used
    • GitHub Wiki Sidebar
    • Neovim
      • Plugins

This wiki has two main types of pages: Quick Guides and Working Notes/Reflections.

Quick Guides are step-by-step guides meant to be fairly straightforward. They are far from in-depth, but are (hopefully) useful to anyone who might happen to see them, particularly myself in the future.

Working Notes/Reflections are notes taken during labs for various classes, or reflections written afterwards. Typically, I will add or edit a couple of Quick Guides that relate to any given class lab between completing it and editing it.

How I maintain this wiki

GitHub wikis are stored as git repositories. I have this embedded as a submodule within the main repository, which I currently need to manually update, but I intend to look into using git hooks to do that automatically, so that when I push changes to the wiki, the submodule is updated to remain up-to-date with the latest commit to the wiki.

I maintain it from 2 systems (array-ctrl, a System76 laptop running Pop!_OS 22.04, and array-lenny, a midrange Lenovo-era Thinkpad running Debian GNU/Linux Bullseye), and the only difference in my setup on each of them is the vim color scheme used.

Structure of pages

My approach to formatting pages on this wiki has evolved over time, and I am working on restructuring older pages to fit my modern structure. Many pages are excluded from the sidebar, and contain only a line like the following:

The contents of this page have been moved to [Penetration Testing: NMap](./Penetration-Testing%3A-NMap).

That is because GitHub wikis do not, to my knowledge, support redirects, and the names are inconsistent with the current structure of this wiki

I try to avoid more than one blank line in a row in the markdown files.

Software Used

GitHub Wiki Sidebar

I use github-wiki-sidebar to maintain the… sidebar (shocker).

Neovim

I use Neovim to write the pages.

Plugins

I use the following plugins for Neovim (maintained with vim-plug)

• airblade/vim-gitgutter - git change information
• mzlogin/vim-markdown-toc - generate table of contents
• plasticboy/vim-markdown - markdown-specific extras
  • godlygeek/tabular - used by plasticboy/vim-markdown for some extra functionality
• tpope/vim-fugitive - git integration that's "so good, it should be illegal!"
• tpope/vim-commentary - comment or uncomment lines in bulk
• xero/sourcerer.vim - A dark color scheme that I find readable and easy on the eyes. I use it on array-lenny
• tomasiser/vim-code-dark - A port of VSCode's Dark+ colorscheme for Neo/vim, which I use on array-ctrl
• preservim/nerdtree - File tree sidebar for vim
  • Xuyuanp/nerdtree-git-plugin - git integration for NERDTree
  • ryanoasis/vim-devicons - Uses "Nerd Fonts" to provide pseudo-icons for files in NERDTree
  • jcharum/vim-nerdtree-syntax-highlight - Color coding for files in NERDTree
• mg979/vim-visual-multi - Multi-cursor implementation

(this is not an exhaustive list of plugins. All of these are in use in maintaining this wiki. Really.)