Code Monkey home page Code Monkey logo

my-notes's Introduction

⚠️ This repo is not maintained anymore, but...

Now I have a 🌱 digital garden.

I host my notes in this repo, and publish them in https://meleu.dev.

Since I knew https://obsidian.md I completely changed my note-taking workflow.

📓 my-notes

Personal notes about things I've been learning (mostly programming).

my-notes repo by meleu

Note: if you want to create your own my-notes repo and get your docs linked like you're seeing below 👇, check the instructions in the header of the update-readme.sh script.

🗃️ Table of Contents

📂 Folders

📝 Notes

my-notes's People

Contributors

gitjournalapp avatar meleu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

my-notes's Issues

use githooks

Use a pre-commit git hook to update the README.md with the list of notes right before commiting a change.

Script to be used as the pre-commit git hook:

#!/usr/bin/env bash
# update-readme.sh
###################
# Update's the readme with links to the repository's content.

readonly SCRIPT_DIR="$(cd "$(dirname $0)" && pwd)"
readonly BASE_URL='https://meleu.github.io/my-notes'
readonly EDIT_URL='https://github.com/meleu/my-notes/edit/master'

linksList() {
  local fileFull
  local fileBase
  local fileNoExtension

  for fileFull in "${SCRIPT_DIR}"/*.md ; do
    fileBase="${fileFull##*/}"
    [[ $fileBase =~ .*README\.md ]] && continue

    fileNoExtension="${fileBase%.*}"

    echo -n "- [${fileNoExtension}](${BASE_URL}/${fileNoExtension})"
    echo " - [✏️](${EDIT_URL}/${fileBase})"
  done
}

main() {
  echo '## 📝 Notes'
  echo
  linksList
}

main "$@"

use jekyll

  • create a really basic layout (inspiration: https://welearncode.com/)
  • use jekyll to generate the pages
  • each page should have a pencil icon link to edit the page

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.