Deal with missing powerline fonts in docs

rbong · Sep 2, 2023 · cb05073 · cb05073
1 parent 356e852
commit cb05073
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -254,10 +254,10 @@ endfunction
 set laststatus=2
 set showtabline=2
 set guioptions-=e
-" Default separators
+" By default, these are powerline-style separators
 let g:crystalline_separators = [
-      \ { 'ch': '', 'alt_ch': '', 'dir': '>' },
-      \ { 'ch': '', 'alt_ch': '', 'dir': '<' },
+      \ { 'ch': '>', 'alt_ch': '|', 'dir': '>' },
+      \ { 'ch': '<', 'alt_ch': '|', 'dir': '<' },
       \ ]
 ```
 

diff --git a/doc/crystalline.txt b/doc/crystalline.txt
@@ -102,6 +102,8 @@ This is a list of objects containing:
 
 Default:
 >vim
+    " These use powerline-style separators
+    " If you're unable to see them, please use a powerline-compatible font
     let g:crystalline_separators = [
           \ { 'ch': '', 'alt_ch': '', 'dir': '>' },
           \ { 'ch': '', 'alt_ch': '', 'dir': '<' },

diff --git a/examples/neovim_lua_examples.md b/examples/neovim_lua_examples.md
@@ -131,10 +131,10 @@ end
 
 vim.o.laststatus = 2
 vim.o.showtabline = 2
--- Default separators
+-- By default, these are powerline-style separators
 vim.g.crystalline_separators = {
-  { ch = "", alt_ch = "", dir = ">" },
-  { ch = "", alt_ch = "", dir = "<" }
+  { ch = ">", alt_ch = "|", dir = ">" },
+  { ch = "<", alt_ch = "|", dir = "<" }
 }
 ```