Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4 Documentation #120

Merged
merged 88 commits into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
a138064
feat: start moving to v4 notation for receipes
mehalter Oct 25, 2023
cb1837e
feat: move more recipes, remove unnecessary documentation pages, add …
mehalter Oct 26, 2023
d569b70
chore: add notices to pages that haven't been updated yet
mehalter Oct 26, 2023
e57fe17
feat: update more recipes
mehalter Oct 27, 2023
cbe8665
Update alpha.md (#130)
JL102 Oct 29, 2023
e5ba0c7
feat(status): update status recipes to v4
mehalter Oct 31, 2023
eac0eb0
feat(recipes): finish updating recipes to v4
mehalter Nov 1, 2023
d033a4a
feat(recipes): add overview to every recipe page
mehalter Nov 1, 2023
8fd76bf
chore: add `stylua` configuration for formatting code in docs
mehalter Nov 3, 2023
286a838
feat: update more pages to v4
mehalter Nov 3, 2023
8ca4afa
feat(autocmds): update autocmds page to v4
mehalter Nov 3, 2023
922ce74
feat(reference): add isolated installation and uninstallation instruc…
mehalter Nov 8, 2023
5a92362
feat(configuration): start core plugins page, added AstroCore
mehalter Nov 9, 2023
2fea97d
feat(configuration): add details on enabling lua language server comp…
mehalter Nov 9, 2023
8583bf2
feat(core_plugins): finish adding details on core plugins
mehalter Nov 9, 2023
d33e0e0
fix(recipes): add types across all recipe snippets
mehalter Nov 9, 2023
8a4ec37
feat: add a placeholder for the "how to use these docs" page
mehalter Nov 9, 2023
73e16da
feat(advanced_lsp): add detailed docs on setting up and configuring l…
mehalter Nov 9, 2023
3207d70
fix(recipes): fix up some recipe code
mehalter Nov 9, 2023
ce6571d
feat(custom_plugins): update documentation on customizing plugins
mehalter Nov 9, 2023
0325ae4
feat: add description to mappings page
mehalter Nov 10, 2023
afb97a1
feat: work on updating instructions for managing user configuration
mehalter Nov 10, 2023
df79c2b
feat: add default plugin list
mehalter Nov 10, 2023
5daa975
feat: more general updates for old pages
mehalter Nov 10, 2023
f8399f9
docs(lua_completion): add tip on AstroLSP LSP configuration completion
mehalter Nov 20, 2023
3ffdf0d
feat: update to use expressive code features
mehalter Nov 20, 2023
be87ad5
feat: use more expressive code features
mehalter Nov 21, 2023
e0b9927
fix: normalize capitalization of sidebar
mehalter Nov 21, 2023
ef495b0
feat: add "Using These Docs" page
mehalter Nov 21, 2023
fb5ae01
chore: clean up formatting
mehalter Nov 21, 2023
0dd2b5f
feat: upgrade to starlight v0.14
mehalter Dec 5, 2023
54dc3f5
feat: update to Astro v4
mehalter Dec 5, 2023
7274121
feat: add upgrade command to `package.json`
mehalter Dec 5, 2023
2e1772f
fix(status): update to new `file_info` component defaults
mehalter Dec 6, 2023
e77ad68
feat(status): add new recipe to add a clock to the statusline
mehalter Dec 6, 2023
ca76ec1
fix(alt_install): fix type in git commands
mehalter Dec 11, 2023
2beb2ae
feat(v4_migration): add introduction and instructions to set up a mig…
mehalter Dec 11, 2023
e51ef25
chore: update dependencies
mehalter Dec 15, 2023
5dcc46e
fix(snippets): update custom snippets instructions
mehalter Jan 11, 2024
4cf1ced
chore: update dependencies
mehalter Jan 11, 2024
93b94a4
fix(status): update default heirline configuratoin
mehalter Jan 13, 2024
e1bc999
fix: update some old imports
mehalter Jan 13, 2024
9d42830
chore: update dependencies
mehalter Jan 17, 2024
eabbf91
chore: update dependencies
mehalter Jan 19, 2024
a8e240c
chore: update tagline
mehalter Jan 27, 2024
9dfb91b
feat(mappings): add new directory session mapping
mehalter Feb 2, 2024
b00030e
chore: update dependencies
mehalter Feb 5, 2024
5d710c0
feat: update to new astrolight theme
mehalter Feb 5, 2024
4d517b5
chore: update dependencies
mehalter Feb 6, 2024
b25fd97
feat(autocmds): add new `AstroLargeBuf` autocmd event
mehalter Feb 6, 2024
272698b
chore: update depdendencies
mehalter Feb 12, 2024
77a0a8d
fix(disable_tabline): options moved to AstroCore
mehalter Feb 13, 2024
307dfa9
feat(mappings): add `<Leader>SD` mapping for deleting a directory ses…
mehalter Feb 14, 2024
421afbf
fix: `get_hlgroup` moved to AstroUI
mehalter Feb 14, 2024
ebc3432
feat: add link back to homepage from documentation
mehalter Feb 19, 2024
7c7a43c
feat(v4_migration): add first draft of the v4 migration guide (#138)
gwww Feb 20, 2024
e9d0723
chore: update dependencies
mehalter Feb 20, 2024
048e43f
feat(recipes): add Project Rooter page
mehalter Feb 20, 2024
f9226db
feat(mappings): add UI/UX mappings
mehalter Feb 20, 2024
8e0774d
fix(rooter): improve table structure
mehalter Feb 20, 2024
4c4cc82
chore: update dependencies
mehalter Feb 20, 2024
50d7157
feat: add tip to migration guide to link to page on Managing User Con…
mehalter Feb 21, 2024
40a354c
feat: add lots of AstroCommunity promotions as well as a dedicated pa…
mehalter Feb 21, 2024
01ac9ab
feat(v4_migration): add some more missing changes in v4
mehalter Feb 21, 2024
d42d704
fix: fix link checking and broken anchor link
mehalter Feb 21, 2024
8819076
fix(faq): update AstroCommunity link
mehalter Feb 21, 2024
2445938
feat: add emojis to page titles
mehalter Feb 21, 2024
4b15131
fix(v4_migration): updated `lsp_handlers` location
mehalter Feb 22, 2024
b6201ad
feat(customizing_plugins): add examples of `list_insert_unique` and `…
mehalter Feb 22, 2024
8ee8e58
chore(faq): fix typos
mehalter Feb 23, 2024
ec80fb7
feat: add `/v3` endpoint for v3 docs
mehalter Feb 23, 2024
04520c8
chore: update dependencies
mehalter Feb 24, 2024
ac3281a
feat(recipes): add recipe for enabling integration with VS Code
mehalter Feb 26, 2024
4510f5d
feat: use new Steps and FileTree features in Starlight
mehalter Mar 1, 2024
a3b11bc
chore: remove unnecessary file
mehalter Mar 3, 2024
a3ef622
feat: use new linux icon
mehalter Mar 4, 2024
53a9924
chore: use client local search until release
mehalter Mar 5, 2024
51326e2
fix!: `signs` and `diagnostics` configuration moved to AstroCore
mehalter Mar 5, 2024
3c78a31
feat(recipes): add Neovide configuration recipe
mehalter Mar 6, 2024
3b9ce7c
fix: incorrect instruction for changing colorscheme (#140)
lallenfrancisl Mar 9, 2024
5e95848
feat(mappings): add completion mappings
mehalter Mar 11, 2024
ff3e411
fix(mappings): correct prev completion mappings (#141)
queue-tip Mar 16, 2024
5a75720
chore: update dependencies
mehalter Mar 20, 2024
103f51c
fix(mappings): update type definition mapping from `gT` to `gy`
mehalter Mar 20, 2024
617743c
feat: add ability to zoom into images
mehalter Mar 20, 2024
a0e9626
fix(migration): add commands for cleaning old neovim configuration
mehalter Mar 28, 2024
9d2d19c
fix: update URLs across the documentation
mehalter Apr 1, 2024
30b83bd
revert: re-enable Algolia search
mehalter Apr 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20
7 changes: 7 additions & 0 deletions .stylua.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
column_width = 80
line_endings = "Unix"
indent_type = "Spaces"
indent_width = 2
quote_style = "AutoPreferDouble"
call_parentheses = "Always"
collapse_simple_statement = "Never"
58 changes: 41 additions & 17 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";

import starlightDocSearch from "@astrojs/starlight-docsearch";
import starlightLinksValidator from "starlight-links-validator";
import starlightImageZoom from "starlight-image-zoom";
import tailwind from "@astrojs/tailwind";

const locales = {
Expand All @@ -17,7 +19,7 @@ export default defineConfig({
locales,
integrations: [
starlight({
title: "AstroNvim Docs",
title: "AstroNvim Documentation",
description: "The documentation website for AstroNvim.",
favicon: "/astronvim.svg",
head: [
Expand Down Expand Up @@ -116,8 +118,17 @@ export default defineConfig({
src: "./src/assets/astronvim.svg",
},
components: {
Search: "./src/components/Search.astro",
SiteTitle: "./src/components/SiteTitle.astro",
},
plugins: [
starlightDocSearch({
appId: "JXZNTZ86UN",
apiKey: "96faee2ebdaf4a8a66d0f810c635bfec",
indexName: "astronvim",
}),
starlightLinksValidator(),
starlightImageZoom(),
],
customCss: [
// Path to your Tailwind base styles:
"./src/tailwind.css",
Expand All @@ -131,57 +142,70 @@ export default defineConfig({
},
sidebar: [
{
label: "Getting started",
label: "🚀 Getting Started",
link: "/",
collapsed: true,
translations: {},
},
{
label: "Basic Usage",
label: "📦 AstroCommunity",
link: "/astrocommunity",
collapsed: true,
autogenerate: { directory: "basic-usage" },
translations: {},
},
{
label: "Configuration",
label: "⌨️ Mappings",
link: "/mappings",
collapsed: true,
translations: {},
},
{
label: "📝 Using This Documentation",
link: "/using_the_docs",
collapsed: true,
translations: {},
},
{
label: "🔧 Configuration",
collapsed: true,
autogenerate: { directory: "configuration" },
translations: {},
},
{
label: "Recipes",
label: "🍳 Recipes",
collapsed: true,
autogenerate: { directory: "recipes" },
translations: {},
},
{
label: "Acknowledgements",
label: "📔 Reference",
collapsed: true,
autogenerate: { directory: "reference" },
translations: {},
},
{
label: "⭐ Acknowledgements",
link: "/acknowledgements",
collapsed: true,

translations: {},
},
{
label: "Code of Conduct",
label: "👪 Code of Conduct",
collapsed: true,
link: "/code_of_conduct",
translations: {},
},
{
label: "Frequently Asked Questions",
label: "❓ FAQ",
collapsed: true,
link: "/faq",
translations: {},
},
{
label: "Core Lua API Documentation",
link: "https://api.astronvim.com",
translations: {},
},
],
lastUpdated: true,
editLink: {
baseUrl: 'https://github.com/AstroNvim/docs/edit/main/'
baseUrl: "https://github.com/AstroNvim/docs/edit/main/",
},
}),
tailwind({
Expand Down
13 changes: 4 additions & 9 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ Cache-Control = "public, max-age=31536000, immutable"
[[plugins]]
package = "@netlify/plugin-lighthouse"
[[plugins]]
package = "netlify-plugin-checklinks"
[plugins.inputs]
skipPatterns = ["dist/404", "id=\"%EF%B8%8F-installation\""]
[[plugins]]
package = "netlify-plugin-submit-sitemap"
[plugins.inputs]
sitemapPath = "/sitemap-index.xml"
Expand All @@ -33,9 +29,8 @@ to = "https://magenta-malasada-aac0c8.netlify.app/:splat"
status = 200
force = true # COMMENT: ensure that we always redirect

# Old paths

[[redirects]]
from = "/Basic%20Usage/*"
to = "/basic-usage/:splat"
status = 301
from = "/v3/*"
to = "https://neon-salmiakki-8da50a.netlify.app/:splat"
status = 200
force = true # COMMENT: ensure that we always redirect
31 changes: 16 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
{
"name": "docs-v2",
"name": "astronvim-documentation",
"type": "module",
"version": "0.0.1",
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
"astro": "astro",
"upgrade": "pnpm dlx @astrojs/upgrade"
},
"dependencies": {
"@astrojs/mdx": "^1.1.5",
"@astrojs/starlight": "^0.13.0",
"@astrojs/mdx": "^2.2.0",
"@astrojs/starlight": "^0.21.2",
"@astrojs/starlight-docsearch": "^0.1.0",
"@astrojs/starlight-tailwind": "^2.0.1",
"@astrojs/tailwind": "^5.0.2",
"@docsearch/css": "^3.5.2",
"@docsearch/js": "^3.5.2",
"astro": "^3.5.5",
"sharp": "^0.32.6",
"tailwindcss": "^3.3.5"
"@astrojs/tailwind": "^5.1.0",
"astro": "^4.5.7",
"sharp": "^0.33.2",
"starlight-image-zoom": "^0.1.0",
"starlight-links-validator": "^0.5.3",
"tailwindcss": "^3.4.1"
},
"devDependencies": {
"@netlify/plugin-lighthouse": "^5.0.0",
"netlify-plugin-checklinks": "^4.1.1",
"@netlify/plugin-lighthouse": "^6.0.0",
"netlify-plugin-submit-sitemap": "^0.4.0",
"prettier": "^3.1.0",
"prettier-plugin-astro": "^0.12.2",
"prettier-plugin-tailwindcss": "^0.5.7"
"prettier": "^3.2.5",
"prettier-plugin-astro": "^0.13.0",
"prettier-plugin-tailwindcss": "^0.5.11"
}
}
Loading