Skip to content

Commit 2f63f31

Browse files
edurbritoedurbrito
committed
Merge branch 'readme'
2 parents c72a7a2 + 5186613 commit 2f63f31

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+9147
-1
lines changed

‎.eslintrc.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"env": {
3+
"node": true,
4+
"es2020": true
5+
},
6+
"extends": [
7+
"standard"
8+
],
9+
"parserOptions": {
10+
"ecmaVersion": 11,
11+
"sourceType": "module"
12+
},
13+
"rules": {
14+
}
15+
}

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
node_modules/
3+
4+
tests/coverage/

‎LICENSE.txt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 edurbrito
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 128 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,128 @@
1-
markdown-notes
1+
<img src="./images/logo.png" style="margin-left: auto; margin-right: auto; display: block;">
2+
3+
----
4+
5+
<h5 style="text-align: center;">markdown-notes</h1>
6+
7+
<h4 style="text-align: center;">Templates for your Note Taking Markdown Workflow</h3>
8+
9+
## Contents
10+
11+
- [Contents](#contents)
12+
- [Overview](#overview)
13+
- [Installation (CLI)](#installation-cli)
14+
- [Using](#using)
15+
- [1. Templates Folder](#1-templates-folder)
16+
- [2. CLI app](#2-cli-app)
17+
- [Examples](#examples)
18+
- [Templates](#templates)
19+
- [Themes](#themes)
20+
- [Default Theme](#default-theme)
21+
- [Contributing](#contributing)
22+
- [License](#license)
23+
24+
## Overview
25+
26+
**Based on some effective study methods (Feynman Technique, Flashcards, Cornell Note Taking Method, Charting Method, Split Page Method etc...), these markdown templates are designed to help on creating better study materials, faster and directly from your computer. Only markdown or html/css skills are required. The styles fully customizable!**
27+
28+
All the working files are contained in these folders:
29+
* [Templates](templates/) - for the markdown templates
30+
* [Themes](themes/) - for the styling themes
31+
32+
> **Important**
33+
> The extension [Markdown Preview Enhanced](https://shd101wyy.github.io/markdown-preview-enhanced/#/), available for VSCode and Atom is required, not only for the notes' styled preview but also for a better html export.
34+
35+
This is a two versions package:
36+
37+
1. If you do want to install the CLI app, a simple command line interface that creates the files on your current directory, follow the instructions in the next [section](#installation-cli).
38+
2. Else, if you only need the templates, copy the files you need (a .md and the corresponding .less file, ex: [note.md](templates/note.md) and [note-style.less](themes/default/note-style.less)), from the previously mentioned folders, paste them wherever you want and start editing them. A Pro Tip is using your machine *Templates* or *Models* folder for a faster template creation.
39+
40+
41+
## Installation (CLI)
42+
43+
> `node` and `npm` are required to be installed on your system.
44+
45+
First, `git clone` this repo. Then go to the downloaded folder and run
46+
47+
`$ npm install`
48+
to install the dependencies
49+
50+
`$ chmod +x md-notes.js`
51+
to make the program executable
52+
53+
`$ npm link`
54+
or
55+
`$ sudo npm link`
56+
to create a bin link and make it possible to call the program globally on your machine.
57+
58+
If everything went with no errors, a successful installation was accomplished.
59+
So... Start [using](#cli-app) it!
60+
61+
## Using
62+
63+
... Having everything set up,
64+
65+
### 1. Templates Folder
66+
67+
If these files are on your machine *Templates* folder, you can easily spawn them on any folder using your file manager context menu.
68+
69+
### 2. CLI app
70+
71+
Else, if you installed the CLI app version, then you need only to run
72+
73+
`$ md-notes`
74+
75+
on your terminal in the desired directory and choose the suitable options.
76+
77+
----
78+
Finally, open your Text Editor (VSCode or Atom) to start crafting and visualizing your markdown notes.
79+
80+
Search for a *Markdown Preview Enhanced* **Preview Button** on the top corners of your editor to open the viewer tab. Search for the extension shortcuts or buttons to export your notes to html, for then opening it on your browser and printing them to pdf.
81+
82+
> See [Themes](#themes) for an overview of the expected visual results
83+
84+
## Examples
85+
86+
There is a [folder](examples/) containing examples of these note templates. They were also exported to html, using the recommended VSCode/Atom extension, and then printed to pdf, directly from the browser.
87+
88+
## Templates
89+
90+
This folder contains all the available markdown templates to start creating and editing the notes. They may be very similar, but all of them must represent the initial header with all the necessary info for linking the styles and start writing the notes.
91+
92+
> Every template must have a corresponding .less file in every available theme, following the current naming and structure.
93+
94+
To help on creating/editing the notes, they may provide some basic code that can be commented and/or urls for some online documentation.
95+
96+
The global font family is also specified in these headers.
97+
98+
## Themes
99+
100+
Currently, there is only one featured theme, the [Default Theme](themes/default/).
101+
More customizations may come in the future.
102+
103+
### [Default Theme](themes/default/)
104+
105+
Some aspects/components of this theme are:
106+
|||
107+
--|--
108+
| h1 or # | ![](images/default/h1.png) |
109+
| h2 or ## | ![](images/default/h2.png) |
110+
| h3 or ### | ![](images/default/h3.png) |
111+
| h4 or #### | ![](images/default/h4.png) |
112+
| h5 or ##### | Similar to h4, but smaller. |
113+
| h6 or ###### | ![](images/default/h6.png) This will appear with a grey background color when previewing or in html. |
114+
| blockquote or > | ![](images/default/blockquote.png) |
115+
| table | ![](images/default/table.png) |
116+
| hr or ---- | Not displayed. It is used for page breaks when printing to pdf. |
117+
118+
## Contributing
119+
120+
**Contributions are all welcome!**
121+
122+
New templates and new themes are appreciated, as well as new features for expanding this idea or make it better, more functional.
123+
124+
Whenever a new template is added, the corresponding style for every suitable theme should be also created. Follow the existing example for the Default Theme.
125+
126+
## License
127+
128+
Licensed under the [MIT license](LICENSE.txt).

‎examples/correctness/images/theory.png‎

44 KB
Loading

‎examples/correctness/q&a-style.less‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
#custom {
2+
font-family: "Handlee", cursive;
3+
text-align: justify;
4+
font-weight: 400;
5+
6+
h1 {
7+
border-bottom: 2px solid #f5f5f5;
8+
padding-bottom: 16px;
9+
text-transform: uppercase;
10+
text-align: center;
11+
line-height: 30%;
12+
letter-spacing: 5px;
13+
font-weight: 500;
14+
font-size: 28px;
15+
margin-bottom: 40px;
16+
}
17+
18+
h2 {
19+
text-transform: capitalize;
20+
color: gray;
21+
letter-spacing: 2px;
22+
line-height: 30%;
23+
font-weight: 300;
24+
font-size: 24px;
25+
margin: 26px;
26+
padding-top: 10px;
27+
}
28+
29+
h2::before {
30+
content: "⋙ ";
31+
}
32+
33+
h3 {
34+
font-weight: 200;
35+
font-size: 20px;
36+
color: gray;
37+
margin: 26px;
38+
}
39+
40+
h3::before {
41+
color: #5c5c5c;
42+
content: "⋗ ";
43+
}
44+
45+
h4 {
46+
font-weight: 200;
47+
font-size: 18px;
48+
color: gray;
49+
margin: 20px;
50+
}
51+
52+
h4::before {
53+
content: "# ";
54+
}
55+
56+
h5 {
57+
padding: 3px;
58+
font-weight: 500;
59+
font-size: 14px;
60+
color: gray;
61+
margin: 20px;
62+
}
63+
64+
h5::before {
65+
content: "# ";
66+
}
67+
68+
h6 {
69+
text-align: right;
70+
background-color: #e9e9e9;
71+
padding: 3px;
72+
font-weight: 300;
73+
color: black;
74+
border-right: 3px solid #6e6e6e;
75+
padding-right: 10px;
76+
margin: 20px;
77+
}
78+
79+
blockquote {
80+
background-color: #f5f5f5;
81+
color: black;
82+
}
83+
84+
blockquote:before {
85+
content: "◬ Nota: ";
86+
}
87+
88+
img {
89+
display: block;
90+
margin-left: auto;
91+
margin-right: auto;
92+
}
93+
94+
table {
95+
width: 100%;
96+
text-align: justify;
97+
font-weight: 400;
98+
margin: 0;
99+
display: inline-table;
100+
}
101+
102+
th {
103+
padding-top: 20px;
104+
text-align: center;
105+
font-weight: 400;
106+
}
107+
108+
td {
109+
text-align: left;
110+
line-height: 5px;
111+
color: white;
112+
padding: 20px;
113+
}
114+
115+
td:hover {
116+
line-height: normal;
117+
color: #3d3d3d;
118+
}
119+
120+
pre {
121+
background-color: rgba(1, 1, 1, 0.075);
122+
font-weight: 500;
123+
font-family: "Handlee", cursive;
124+
}
125+
126+
p {
127+
margin-bottom: 2px;
128+
}
129+
130+
ul {
131+
margin-block-end: 0;
132+
margin-bottom: 2px;
133+
}
134+
135+
hr {
136+
visibility: hidden;
137+
margin: 0px;
138+
page-break-after: always;
139+
}
140+
141+
@media print {
142+
td {
143+
text-align: left;
144+
color: #3d3d3d;
145+
line-height: normal;
146+
}
147+
}
148+
}

0 commit comments

Comments
 (0)