Skip to content
This repository has been archived by the owner on Jun 11, 2023. It is now read-only.

Zygmut/web-notepad

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notepad

Web notepad


A minimal web-based notepad!

🧠 About

Why

I love minimalism. When I was in my first year of college, I was struggling to keep my phase taking notes on lectures as my handwritting isn't the best. The default notepad on windows worked just fine, but it lacked in ✨desing✨ and some times I tought to myself "I could do a better job". I ended up using vim, but not many people like using the command line to take notes. And so, I started to develop this notepad as a way to warm up to my next semester of college

How is this better from a default notepad

  • The design is really minimalistic, reducing posible distractions
  • You can customize almost every aspect on the config file
  • Dark/light mode

🌐 Language List

At this point in development, we support the following languages:

  • English
  • Spanish
  • Catalan

🏁Getting started

These instructions will get you started on running this web locally to take full advantage of the configuration

📩 Installation

  • Clone this repository via de clone command or download de latest release
  • Open the index.html with your favorite web browser

⚙️ Configuration

The configuration file can be found in the main folder, besides the ìndex.html. In it you'll find the list of all posible modificable aspects (without touching the code) that I've thought. Let's go one by one:

Variable Description Possible values
language Default language See List of languages
dark_mode Default theme (Dark/light) true/false
icon_mode Toggles text visibility (Only show icons) true/false
zen_mode Toggles menu button visibility true/false
font_family Default font family See list of fonts in your OS
font_size Default font size e.g. 25px
animation_speed Default animation speed. Set to 0 to disable e.g. 0.2s
icon_size Default icon size e.g. 30px
navbar_height Default navigation bar height. Set to 0 to have the height of the font e.g. 50px

The rest of variables are color codes for light and dark mode respectivelly, so you can set your own theme colors

✍️ Who can contribute?

Really anyone. I learned a lot doing this project, so I encourage other people to see how this web works and If you want to expand on the language list or add new features, go for it!

📚 Actual dev state

You can see at any time what I'm working on with this link, that will lead you to a clickup board

🙇 Inspiration

🛠️ Built it using