Skip to content

Commit 7a15074

Browse files
author
BrunoCiccarino
committed
feat(docs): adding intro to doc
1 parent e9f0494 commit 7a15074

15 files changed

+555
-185
lines changed

.github/workflows/deploy.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build-and-deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v3
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v3
18+
with:
19+
node-version: "18"
20+
cache: "npm"
21+
22+
- name: Install dependencies
23+
run: npm ci
24+
25+
- name: Build the site
26+
run: npm run build
27+
28+
- name: Move build files to root
29+
run: |
30+
cp -r dist/* .
31+
32+
- name: Deploy to GitHub Pages
33+
uses: peaceiris/actions-gh-pages@v3
34+
with:
35+
github_token: ${{ secrets.GITHUB_TOKEN }}
36+
publish_dir: .

blog/2019-05-28-first-blog-post.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

blog/2019-05-29-long-blog-post.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

blog/2021-08-01-mdx-blog-post.mdx

Lines changed: 0 additions & 24 deletions
This file was deleted.
Binary file not shown.

blog/2021-08-26-welcome/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

blog/authors.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

blog/tags.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/img/fastcodecompletions.jpg

32.3 KB
Loading

docs/intro.md

Lines changed: 93 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,118 @@ sidebar_position: 1
44

55
# Tutorial Intro
66

7-
Let's discover **Docusaurus in less than 5 minutes**.
7+
Let's discover **Fastvim in less than 5 minutes**.
88

99
## Getting Started
1010

11-
Get started by **creating a new site**.
11+
Welcome to Fastvim, the next-gen galactic ☄️ Neovim distro that’s fast, modern, and fully configurable. Built for both lazy people who don’t want to mess around with endless configurations, and for the martian 👽 Neovim hackers who want full control over their setup. Whether you just want things to work right out of the box or you love tweaking every little detail, Fastvim is here to help.
1212

13-
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
13+
This distro has everything you need for a smooth and efficient workflow, and if you’re feeling adventurous, you can dive in and make it your own. With custom themes 🎨 made just for you, if you like having themes for every phase and mood you’re going through, just like me.
1414

15-
### What you'll need
15+
Get ready to experience a Neovim setup that just works, without all the hassle. Let’s get you set up, fast and easy!
1616

17-
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
18-
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
17+
### 📦 requirements
1918

20-
## Generate a new site
19+
- Neovim >= 0.9.0 (needs to be built with LuaJIT)
20+
- Git >= 2.19.0 (for partial clones support)
21+
- a Nerd Font(v3.0 or greater) (optional, but needed to display some icons)
22+
- a C compiler for nvim-treesitter. See [here](https://github.com/nvim-treesitter/nvim-treesitter#requirements)
23+
- pnpm for compile live server plugin (optional, but needed to load live server)
24+
- build-essential needed to compile lua snip
2125

22-
Generate a new Docusaurus site using the **classic template**.
26+
## 💤 Installation
2327

24-
The classic template will automatically be added to your project after you run the command:
28+
> Please, before installing, remember to make a backup of your dotfiles.
29+
30+
```
31+
mv ~/.config/nvim ~/.config/nvim.bak
32+
mv ~/.local/share/nvim ~/.local/share/nvim.bak
33+
34+
# optional but recommended
35+
mv ~/.local/state/nvim{,.bak}
36+
mv ~/.cache/nvim{,.bak}
37+
```
38+
39+
#### linux or mac
2540

2641
```bash
27-
npm init docusaurus@latest my-website classic
42+
git clone https://github.com/fastvim/fastvim.git ~/.config/nvim
43+
cd .config/nvim
44+
nvim # Then it will download everything by itself
45+
```
46+
#### Windows
47+
48+
```posh
49+
git clone https://github.com/fastvim/fastvim.git $HOME\AppData\Local\nvim
50+
```
51+
52+
### 💻 Setup
53+
54+
For the distro to work as expected, we need to configure a few things, let's start by downloading the lsp(language server protocol) that you will use by installing with mason
55+
56+
To do this you type: `MasonInstall LspName`
57+
58+
Ex:
59+
60+
```
61+
:MasonInstall clangd
62+
```
63+
Or if you are java dev
64+
65+
```
66+
MasonInstall jdtls
2867
```
2968

30-
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
69+
Lsp (language server protocol) bring you countless benefits when coding, such as auto completions, syntactic error warnings in real time, and for this we have some plugins like [blink-cmp](https://github.com/Saghen/blink.cmp), for snippets we have [ luasnip](https://github.com/L3MON4D3/LuaSnip) that works exceptionally well and we have mini.pairs to autocomplete special characters like [], (), etc...
3170

32-
The command also installs all necessary dependencies you need to run Docusaurus.
71+
![code-completions](./img/fastcodecompletions.jpg)
3372

34-
## Start your site
73+
With the setup complete, you're now ready to dive into using your new Neovim IDE. Let's get started!
3574

36-
Run the development server:
75+
### Quickstart
76+
77+
Now that everything is set up, let's jump into using FastVim. Follow these steps to start coding efficiently:
78+
79+
Open Neovim
80+
Launch Neovim by running:
81+
82+
```bash
83+
nvim
84+
```
85+
Explore the Dashboard
86+
Upon starting Neovim, you'll see a customizable dashboard. Use it to quickly open recent files, create new projects, or access settings.
87+
88+
Install Plugins
89+
Ensure all required plugins are installed by running:
90+
91+
```bash
92+
:Lazy
93+
```
94+
This will display the plugin manager. Press u to update all plugins.
95+
96+
Set Up LSP
97+
If you haven't installed your language server yet, use Mason:
98+
99+
```bash
100+
:MasonInstall LspName
101+
```
102+
Replace LspName with the appropriate server for your language (e.g., clangd for C/C++, jdtls for Java).
103+
104+
Start Coding
105+
Open a file or create a new one:
37106

38107
```bash
39-
cd my-website
40-
npm run start
108+
nvim myfile.extension
41109
```
110+
Replace extension with the file type you're working with (e.g., java, go, sql). Autocompletions, syntax highlighting, and LSP features will be ready to assist you.
42111

43-
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
112+
**update distro**
44113

45-
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
114+
To update the distro you have two options, `:FastUpdate` which will update the distro to the latest version, and `:FastStable` which will update the distro to the latest stable version (recommended)
46115

47-
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
116+
**Explore Keymaps**
117+
This configuration comes with pre-mapped keys for common actions. Check the keybindings guide by pressing:
118+
119+
```bash
120+
:help keymaps
121+
```

0 commit comments

Comments
 (0)