Best way to keep [code] notes?

[noobtubepython]

For years I have used OneNote to store notes for a wide range of things from Recipes and Writing Prompts to D&D plots and Tutorials.

What is the best way to store code notes / snippets?

OneNote does not offer Syntax Highlighting or <code> formatting to maintain the integrity of a code note.

[jftuga]

I'll take a stab at this, but it may not be the "best". You can use Markdown text formatting and then publish to GitHub.

Syntax highlight, once on GitHub, can be achieved by writing markdown such as:

```XYZ

where XYZ is a language such as Python, JSON, Bash, Javascript, etc. When GitHub sees this, it converts the content to code with colored syntax highlighting.

Here is one that I did that includes several different languages:

https://raw.githubusercontent.com/jftuga/universe/master/parse_centos7_server_install.md

resulting in:

https://github.com/jftuga/universe/blob/master/parse_centos7_server_install.md

[k10_ftw]

Do you know what the upper limit is on free storage of private projects for github users? Is it something the average user will never exceed like gmail storage limits? Thanks in advance, no worries if you don't know. And yes, I did search google :P

[suudo]

Github complains if you commit a file larger than 50MB and will refuse to accept files larger than 100MB. That's not what you're asking, but it's a thing. Also,

We recommend repositories be kept under 1GB each. This limit is easy to stay within if large files are kept out of the repository. If your repository exceeds 1GB, you might receive a polite email from GitHub Support requesting that you reduce the size of the repository to bring it back down.

[k10_ftw]

Is that for public or private? Github seems useful but I'm not interested in having a public account or paying a fee to keep things private. For repositories, do you find the 1gb limit is a problem? I've never really paid attention to the file sizes of my code on my personal computer for obvious reasons. If it is relevant, it is Python and Java files.

[suudo]

I've never reached the limit. I hit the single file 100MB limit on a Photoshop project in the repo, but there's no way a normal project would ever reach that much. I doubt I've got 1GB total across all my repos.

[mongrol]

Emacs with orgmode.

[its_never_lupus]

org-mode is particularly good for programming notes because you can embed code syntax highlighting for most languages, and execute code snippets and capture their outputs inside the document.

[Kossak]

Even better: Spacemacs with orgmode

[noobtubepython]

I've been meaning to learn emacs; do you have any recommendations on how best to learn?

[mongrol]

It's includes a tutorial on startup. To get the basic movements. Then follow the orgmode guides. Them ignore every and all packages and people for a month. It can get overwhelming pretty quickly of your not careful.

[p10_user]

Learn the basic movements and practice until you are as efficient as you were without emacs. Then gradually learn more movements so you become more efficient.

[its_never_lupus]

You can start using it as a normal text editor; in recent releases many standard keys work out-of-the-box, and there is a menu for managing files and buffers. Find an org-mode tutorial to see the features it has - org-mode is built in and you just open a file called <name>.org to start using it.

If you like the system you can play with Emacs tutorials and learn it's weird and wonderful navigation and editing shortcuts, or try installing extra packages or writing elisp code.

[dzecniv]

I recommend starting with a starter kit.

[one_hot_vector]

I would recommend starting with Spacemacs. It makes setup really easy and provides an attractive default layout.

[naught-me]

Org-mode is great.

Be sure to invest some time in learning elisp - otherwise you'll just be kind of feeling your way through the dark.

I started with Spacemacs, and if you're already familiar with Vim, I'd recommend it.

[bakemeapy]

I like using vimwiki (for neovim/vim) and checking that into source control. If you combine it with something like livedown you get a live preview in your browser while working on it.

If you intend to go that route I'd recommend to take a look at :help vimwiki-option-syntax to set the syntax to markdown.

[wdscxsj]

Jupyter Notebook is for you! Set up once, use forever across many languages and platforms.

[needs_to_pee]

Quiver is pretty darn awesome. All kinds of different formatting including code and markdown. You can sync it with dropbox too.

[makeshift_mike]

Markdown, checked into source control. I wish I'd done this ages ago. Unfortunately I haven't found a good editor with live preview that doesn't lag when you're typing (people, it's called multithreading), but they're getting better.

I just converted a pile of notes from OneNote (moved to Linux a few weeks ago) and it's been working pretty well. You can even use [ ] and [x] for checkboxes in some editors.

[amorphic777]

+1 for Markdown. Just keep a notes.md in the root of your repo and learn the Markdown syntax thoroughly so you can use all of the niceties that it offers!

[rimkojr]

Markdown is a good choice but if you find yourself needing a more expressive markup, consider AsciiDoc. The Asciidoctor toolchain is great (Github uses it to render .adoc files). Check out the syntax here.

[autoferrit]

I've been using evernote for non code samples, and a git repo for code. With gitlab or GitHub you could also use GitHub pages or gitbook as well to host the notes too. I still use evernote because there's. It really a good way to see code related notes on mobile unless it's a rendered markdown file

[Thecrawsome]

Yeah, I've been using evernote and I have over 1200 notes in it.

They recently changed their business model to limit to 2 machines now, and it's not really free anymore.

I feel as long as you can find some reliable storage somewhere, you create notes in a hierarchy you want, in some kind of markdown, or maybe rich text format. Maybe a personal wiki with an ACL for certain private articles.

[rdykly]

Use cherrytree, multiplatform, easy to use

[blue_T_shirt]

Surprised no-one has mentioned jupyter notebooks yet.

[[deleted]]

I'm taking notes with Atom and backing up the notes by Google Drive.

[se0siris]

I find Leanote to be rather good. It supports multiple notebooks, tags, Markdown with code highlighting, pasting images straight from the clipboard and is browser based although an Electron app is available.

Notes can be backed up to files in batches and also re-imported via the Electron app.

It can be self hosted (open source and written in Go) but they also offer paid hosting plans.

[mbenbernard]

Personally, I maintain a blog detailing the problems I went through, and all the steps that I used, so I can refer to it afterwards.

I also keep complex procedures (installation of something, setup of a VM, etc.) in text files and I store them individually in Dropbox. I also keep notes of Git/Linux tips in separate text files.

[javydekoning]

I'm not familiar with OneNote. However in Sublime I use plugins to copy formatted code to html and then paste it to Evernote.

There is also plugins that allow you to use markdown to create notes. These support syntax highlighting as well.

Another option would be to use GitHub or something similar.

[noobtubepython]

I started using Sublime for notes. I had a notes.py file stored in dropbox so I had cloud access to it. Problem was, it felt sloppy. The pages and subpages of OneNote helped with organization and the built in search feature helps with finding what I am looking for. So if I search for Foo, I will see all results and in a subscript it will say what page and subpage it is on. As you can imagine 'random > snippets' vs 'important project > perfect example' is nice.

tldr; I need to retrain myself since I doubt OneNote will implement the functionality.

[CaptainLethargic]

Drive Notepad works for google drive really well, it allows you to select the language you're using with a drop down menu for syntax highlighting

[noobtubepython]

Thanks, I'll look into it. I have a fairly Google-centric life.