Update contents (#5)

* Quick update README and fix linting

* Fix linting and update vscode settings

* update local development without git (#9)

* Update packages

* rename to README, update links

---------

Co-authored-by: Samir M <[email protected]>

.cspell.json

@@ -1,5 +1,64 @@
 {
   "language": "en",
-  "words": ["asdf", "hackyourfuture", "monospace", "Precourse"],
+  "words": [
+    "asdf",
+    "hackyourfuture",
+    "monospace",
+    "Precourse",
+    "hihat",
+    "transitionend",
+    "keydown",
+    "markdownlint",
+    "stylelint",
+    "ENOENT",
+    "blockquote",
+    "syle",
+    "webservers",
+    "frontends",
+    "platyrun",
+    "gabor",
+    "cheatsheet",
+    "owanateamachree",
+    "learngitbranching",
+    "Nepo",
+    "exsit",
+    "shortcutfoo",
+    "speedcoder",
+    "thepracticetest",
+    "mltype",
+    "Typer",
+    "academind",
+    "speedtyper",
+    "makeareadme",
+    "bulldogjob",
+    "meakaakka",
+    "freecodecamp",
+    "Showalter",
+    "bashcrawl",
+    "heynode",
+    "npmjs",
+    "ohmygit",
+    "Katas",
+    "rebasic",
+    "githubtraining",
+    "Daigle",
+    "Legos",
+    "opensource",
+    "choosealicense",
+    "techsoup",
+    "infoworld",
+    "opensource",
+    "opensourcedesign",
+    "mozillascience",
+    "briandk",
+    "opensource",
+    "voxmedia",
+    "pybot",
+    "gitbook",
+    "Unmesh",
+    "Samir",
+    "Bermarte",
+    "DeNepo"
+  ],
   "ignorePaths": ["node_modules/**", "**/*.json", "**/*.mp4", "**/*.svg"]
 }

.github/pull_request_template.md

@@ -6,9 +6,9 @@
   - connect it to a milestone (if necessary)
   - link it with an issue (if necessary)
 -->
+<!-- markdownlint-disable-file -->
 
 <!-- describe your PR -->
-<!-- markdownlint-disable-next-line first-line-heading first-heading-h1 -->
 
 ## Description
 

.vscode/settings.json

@@ -110,5 +110,8 @@
   // Defines a default markdown formatter which takes precedence over all other formatter settings. Must be the identifier of an extension contributing a formatter
   "[markdown]": {
     "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
-  }
+  },
+
+  // Enable/disable update table of contents on save
+  "markdown.extension.toc.updateOnSave": false
 }

0-local-development-without-git/README.md

@@ -1 +1,17 @@
 # Local Development Without Git
+
+## Command Line Interface(CLI)
+
+- [CLICK HERE](./cli/README.md)
+
+## Markdown
+
+- [CLICK HERE](./markdown/README.md)
+
+## VS Code
+
+- [CLICK HERE](./vscode/README.md)
+
+## NPM
+
+- [CLICK HERE](./npm/README.md)

0-local-development-without-git/cli/README.md

@@ -0,0 +1,92 @@
+# Command Line Interface
+
+## What is CLI?
+
+> The Command Line Interface (CLI) is an editing environment that is text-based.
+> It uses specified text (known as commands) to interact with the computer and
+> perform numerous operations, including installing and working with programs.
+>
+> [https://www.freecodecamp.org/](https://www.freecodecamp.org/news/how-to-use-the-cli-beginner-guide/)
+
+## Basic Command Unix-like
+
+`man` : to show the usage manual, or help page, for a command
+
+```Markdown
+man <command>
+man ls
+```
+
+`pwd` : to see where we are, we can print working directory
+
+```Markdown
+pwd
+```
+
+`ls` : lists the files and directories in the current working directory
+
+```Markdown
+ls
+```
+
+`cd` : to change directory
+
+```Markdown
+cd  <directory-name>
+```
+
+`cd ..` : to move up one directory
+
+```Markdown
+cd  ..
+```
+
+`mkdir` : to create a new directory(folder)
+
+```Markdown
+mkdir  <directory-name>
+```
+
+`touch` : to create a new file
+
+```Markdown
+touch  <file-name>
+```
+
+`rm` : to delete files or directories
+
+```Markdown
+rm <file-name>
+rm -r <directory-name>
+```
+
+`echo` : to print the string pass to it as argument
+
+```Markdown
+echo "Hello world!"
+```
+
+`cat` : to print the contents of files
+
+```Markdown
+cat  file.txt
+```
+
+`exit` : to end a shell session
+
+```Markdown
+exit
+```
+
+`history` : to displays an enumerated list with the commands you’ve used in the
+past
+
+```Markdown
+history
+```
+
+`clear` : to clean up the screen or you can use the shortcut `Ctrl + l`
+
+```Markdown
+clear
+```

0-local-development-without-git/file-extensions/exercises/file-04

@@ -1,11 +1,15 @@
 # see what is in the directory
+
 ls
 
 # see what is in the sub-directory
+
 ls ./file-extensions
 
 # navigate to the sub-directory
+
 cd ./file-extensions
 
 # print the README to the console
+
 cat ./README.md

0-local-development-without-git/markdown/README.md

@@ -8,11 +8,11 @@ Open Source Software projects for everything except the code itself.
 Fortunately, markdown is also pretty simple. You won't be writing your
 applications in Markdown but you will be using all the time to:
 
-- plan your projects as a group
-- review each other's code
-- document your code
-- keep track of your class work
-- and maybe even to keep your notes!
+- Plan your projects as a group
+- Review each other's code
+- Document your code
+- Keep track of your class work
+- Maybe to keep your notes!
 
 ---
 
@@ -22,19 +22,30 @@ Well, there isn't really that much to study. You can learn everything you need
 to learn just by writing a few good READMEs. These resources should be enough to
 get you going
 
-- the [Markdown Tutorial](https://www.markdowntutorial.com/)
+- [Markdown Tutorial](https://www.markdowntutorial.com/)
 - Example markdown files in the [./examples](./examples) folder
 - [Markdown CheatSheet PDF](./cheatsheet.pdf) (downloaded from
   [here](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf))
 
 ---
 
-## Writing Markdown in VSCode
+## Writing Markdown in VS Code
 
-VSCode has a lot to help you write Markdown:
+VS Code has a lot to help you write Markdown:
 
 - The `./markdown-in-vscode.md4` video demos some helpful features
 - You can read the
-  [VSCode Documentation](https://code.visualstudio.com/Docs/languages/markdown)
+  [VS Code Documentation](https://code.visualstudio.com/Docs/languages/markdown)
 - And there are many helpful extensions you can install. The most important are
   listed in the Precourse assignments
+
+## Example
+
+- [headers](./examples/headers.md)
+- [images](./examples/images.md)
+- [emphasis](./examples/emphasis.md)
+- [links](./examples/links.md)
+- [lists](./examples/lists.md)
+- [text](./examples/text.md)
+- [table](./examples/tables.md)
+- [code blocks](./examples/code-blocks.md)

0-local-development-without-git/npm/README.md

@@ -0,0 +1,54 @@
+# NPM
+
+## What is npm?
+
+NPM is Node Package Manager, provides two functionalities:
+
+- Online repositories for node.js packages/modules which are searchable on
+  search.nodejs.org
+- Command line utility to install Node.js packages, do version management and
+  dependency management of Node.js packages.
+
+## Some npm Commands
+
+To check npm version
+
+```Markdown
+npm --version
+```
+
+To create `package.json`
+
+```Markdown
+npm init
+```
+
+To install package
+
+```Markdown
+npm install <package name>
+```
+
+To update package
+
+```Markdown
+npm update  <package name>
+```
+
+To install a package and any packages that it depends on
+
+```Markdown
+npm install
+```
+
+To uninstall package(s)
+
+```Markdown
+npm uninstall <package name>
+```
+
+To run script
+
+```Markdown
+npm run <script name>
+```

0-local-development-without-git/vscode/README.md

@@ -0,0 +1,77 @@
+# VS Code Basic Shortcuts
+
+## Open a Repository in VS Code
+
+### Mac
+
+```Markdown
+command + o
+```
+
+### Windows
+
+```Markdown
+Ctrl + o
+```
+
+## Open VS Code from Terminal
+
+### Mac
+
+```Markdown
+command + j
+```
+
+### Windows
+
+```Markdown
+Ctrl + `
+```
+
+## Add a New File
+
+### Mac
+
+```Markdown
+command + n
+```
+
+### Windows
+
+```Markdown
+Ctrl + n
+```
+
+## Add a New Folder
+
+### Mac
+
+```Markdown
+command + shift + p  => type : new folder => select File : New Folder
+```
+
+### Windows
+
+```Markdown
+Ctrl + shift + p  => type : new folder => select File : New Folder
+```
+
+## Format a File
+
+### Mac
+
+```Markdown
+shift + option + f
+```
+
+### Windows
+
+```Markdown
+shift + alt + f
+```
+
+## More Shortcuts
+
+- [Mac](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf)
+- [Windows](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf)
+- [Linux](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf)