sufyaan-website/vimwiki/vimwiki.tex

% Options for packages loaded elsewhere
\PassOptionsToPackage{unicode}{hyperref}
\PassOptionsToPackage{hyphens}{url}

\documentclass[
]{article}
\usepackage{amsmath,amssymb}
\usepackage{titlesec}
\usepackage{titling}
\usepackage{lmodern}
\usepackage{xcolor}
\usepackage{iftex}
\usepackage[margin=1in]{geometry}
\ifPDFTeX
  \usepackage[T1]{fontenc}
  \usepackage[utf8]{inputenc}
  \usepackage{textcomp} % provide euro and other symbols
\else % if luatex or xetex
  \usepackage{unicode-math}
  \defaultfontfeatures{Scale=MatchLowercase}
  \defaultfontfeatures[\rmfamily]{Ligatures=TeX,Scale=1}
\fi
% Use upquote if available, for straight quotes in verbatim environments
\IfFileExists{upquote.sty}{\usepackage{upquote}}{}
\IfFileExists{microtype.sty}{% use microtype if available
  \usepackage[]{microtype}
  \UseMicrotypeSet[protrusion]{basicmath} % disable protrusion for tt fonts
}{}
\makeatletter
\@ifundefined{KOMAClassName}{% if non-KOMA class
  \IfFileExists{parskip.sty}{%
    \usepackage{parskip}
  }{% else
    \setlength{\parindent}{0pt}
    \setlength{\parskip}{1pt plus 2pt minus 1pt}}
}{% if KOMA class
  \KOMAoptions{parskip=half}}
\makeatother
\definecolor{myblue}{RGB}{24, 102, 201}
\titleformat{\section}
{\huge\bfseries\color{myblue}}
{}
{0em}
{}[\titlerule]

\titleformat{\subsection}
{\Large\bfseries}
{}
{0em}
{}

\titleformat{\subsubsection}[runin]
{\bfseries}
{}
{0em}
{}[:]

\titlespacing{\subsubsection}
{0em}{0.75em}{0.5em}

\titlespacing{\subsection}
{0em}{1em}{0.65em}

\titlespacing{\maketitle}
{0em}{0em}{0em}
\renewcommand{\maketitle}{
	\begin{center}
		{\huge\bfseries \theauthor}\\
		\vspace{.35em}
		sufyaan.me/vimwiki
	\end{center}
}
\usepackage{color}
\usepackage{fancyvrb}
\newcommand{\VerbBar}{|}
\newcommand{\VERB}{\Verb[commandchars=\\\{\}]}
\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}}
% Add ',fontsize=\small' for more characters per line
\newenvironment{Shaded}{}{}
\newcommand{\AlertTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}
\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.49,0.56,0.16}{#1}}
\newcommand{\BaseNTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
\newcommand{\BuiltInTok}[1]{\textcolor[rgb]{0.00,0.50,0.00}{#1}}
\newcommand{\CharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
\newcommand{\CommentTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textit{#1}}}
\newcommand{\CommentVarTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.53,0.00,0.00}{#1}}
\newcommand{\ControlFlowTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}}
\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.56,0.13,0.00}{#1}}
\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.73,0.13,0.13}{\textit{#1}}}
\newcommand{\ErrorTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}
\newcommand{\ExtensionTok}[1]{#1}
\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.02,0.16,0.49}{#1}}
\newcommand{\ImportTok}[1]{\textcolor[rgb]{0.00,0.50,0.00}{\textbf{#1}}}
\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}}
\newcommand{\NormalTok}[1]{#1}
\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}}
\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{#1}}
\newcommand{\PreprocessorTok}[1]{\textcolor[rgb]{0.74,0.48,0.00}{#1}}
\newcommand{\RegionMarkerTok}[1]{#1}
\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.73,0.40,0.53}{#1}}
\newcommand{\StringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.10,0.09,0.49}{#1}}
\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
\newcommand{\WarningTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
\setlength{\emergencystretch}{3em} % prevent overfull lines
\providecommand{\tightlist}{%
  \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}
\setcounter{secnumdepth}{-\maxdimen} % remove section numbering
\ifLuaTeX
\usepackage[bidi=basic]{babel}
\else
\usepackage[bidi=default]{babel}
\fi
\babelprovide[main,import]{english}
% get rid of language-specific shorthands (see #6817):
\let\LanguageShortHands\languageshorthands
\def\languageshorthands#1{}
\ifLuaTeX
  \usepackage{selnolig}  % disable illegal ligatures
\fi
\IfFileExists{bookmark.sty}{\usepackage{bookmark}}{\usepackage{hyperref}}
\IfFileExists{xurl.sty}{\usepackage{xurl}}{} % add URL line breaks if available
\urlstyle{same} % disable monospaced font for URLs
\hypersetup{
  pdftitle={(POST) VimWiki Is Terrific},
  pdflang={en},
  colorlinks=true,
  linkcolor=blue,
  filecolor=blue,
  urlcolor=blue,
  pdfcreator={LaTeX via pandoc}}

\title{Sufyaan's Website}
\author{Sufyaan's Website}
\date{}

\begin{document}
\maketitle

\section[VimWiki Is Terrific]{VimWiki Is Terrific}\label{why-i-use-terminal-apps}

\textbf{26 July 2023}


\textbf{Category: }Linux


I have recently been using
\href{https://github.com/vimwiki/vimwiki}{VimWiki} to take all of my
notes instead of Joplin, and it has been working really well. It has its
own \href{../definitions/markdown}{Markdown (.md)} format, but I use
regular \href{../definitions/markdown}{Markdown (.md)} with it. I use
Syncthing to sync all my notes to all of my devices. There is barely any
delay, so there are never any conflict issues.

\hypertarget{what-is-vimwiki}{%
\subsection[What Is VimWiki?]{What Is VimWiki?}\label{what-is-vimwiki}}

VimWiki is a plugin for Vim or Neovim that allows you to create a
personal wiki. On this wiki, you can add anything you want. It is
essentially \href{https://obsidian.md/}{Obsidian} but more minimal and
scriptable.

Since it runs in Vim or Neovim, it is extremely fast, lightweight and
has barely any bloat. It runs blazingly fast even on old devices. The
capability is also extremely high, since you can edit files at light
speed when you learn Vim or Neovim properly.

\hypertarget{how-is-it-useful}{%
\subsection[How Is It Useful?]{How Is It
Useful?}\label{how-is-it-useful}}

Using VimWiki, it is trivial to organise notes, ideas, diaries, to-do
lists or even future plans. It supports tables, links and much more.
There is even an option to export your
\href{../definitions/markdown}{Markdown (.md)} files to HTML, which
allows you to create webpages quickly.

VimWiki is so versatile that I wrote this post completely in VimWiki.
View the raw \href{../definitions/markdown/}{Markdown (.md)} file
\href{vimwiki.md}{here}

It allows you to do everything regular
\href{../definitions/markdown}{Markdown (.md)} can do and more. For
example, you can have checklists with progress on them, like this;

\textbf{{[} {]} -\/-\textgreater{} 0\% complete}

\textbf{{[}.{]} -\/-\textgreater{} 1\% - 33\% complete}

\textbf{{[}o{]}-\/-\textgreater{} 33\% - 66\% complete}

\textbf{{[}O{]}-\/-\textgreater{} 66\% - 99\% complete}

\textbf{{[}X{]}-\/-\textgreater{} 100\% complete}

You can even have pre-formatted text. This makes it useful to add and
explain code.

\hypertarget{how-do-you-use-it}{%
\subsection[How Do You Use It?]{How Do You Use
It?}\label{how-do-you-use-it}}

On my computers, I use Neovim to use VimWiki. When it comes to my phone,
I use the \href{https://github.com/gsantner/markor}{Markor} app, which
is a \href{../definitions/markdown}{Markdown (.md)} viewer. It is not
the best experience on mobile, but I am willing to give that up for an
amazing experience on my computers, since I use and note down things on
my computer more.

The reason I am using VimWiki now is mainly to stay in line with me
preferring plaintext to proprietary note apps or formats. As I mentioned
in my last post, I try to use as much plaintext as possible to prevent
distractions and have easy access to my notes wherever and whenever I
want to.

\hypertarget{conclusion}{%
\subsection[Conclusion]{Conclusion}\label{conclusion}}

To conclude, I switched to VimWiki because I find it faster and easier
to use Neovim directly on my computer. I love using
\href{../definitions/markdown}{Markdown (.md)}, so I feel at home when
using VimWiki. It is also because I prefer to use plaintext as much as
possible.

\end{document}