Skip to content

Commit 7eee19d

Browse files
committed
doc(wiki): update home
1 parent 23616ae commit 7eee19d

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

.github/workflows/doc.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ jobs:
5050
run: |
5151
WIKIUPDATER=$(git log -1 --pretty=format:%an -- wiki)
5252
echo "Wiki Updated By $WIKIUPDATER"
53-
git status
5453
cd banana.nvim.wiki
54+
git status
5555
git config --local user.email "action@github.com"
5656
git config --local user.name "$WIKIUPDATER"
5757
git add .

wiki/Home.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Articles will (eventually), when possible, link to relevant MDN docs pages with
88

99
## Goals
1010

11-
_Currently_, the goal for banana is to implement enough of a subset of html and css such that it is possible to make anything. There are several niceties in html and css that would probably be very easy to implement right now (namely other css selector types), but my goals are to get maximize the library capabilities before rounding out the feature set. If you would like one of these features, post an issue. I will happily add a feature if you want it, but I will not work on some of these features unless asked to.
11+
_Currently_, the goal for banana is to implement enough of a subset of html and css such that it is possible to make anything. There are several things in html and css that would probably be very easy to implement right now (namely other css selector types), but my goals are to get maximize the library capabilities before rounding out the feature set. I will happily add a feature if you want it, but some features I probably will not work on until asked
1212

1313
## Getting started
1414

@@ -19,16 +19,24 @@ To get started, you can either run the command `:BananaSo` while in an nml file,
1919
To set up an instance for usage in a plugin, use the below code:
2020

2121
```lua
22-
-- the buffer name can be overriden using the <title> tag
23-
local document = require('banana.instance').newInstance("banana require path", "initial buffer name")
2422

25-
-- can also use
26-
local document = require("banana.instance").emptyInstance()
23+
local document = nil
24+
25+
if document ~= nil then
26+
-- the buffer name can be overriden using the <title> tag
27+
-- should only create ONE instance and manage all state from that
28+
document = require('banana.instance').newInstance("banana require path", "initial buffer name")
29+
30+
-- can also use
31+
document = require("banana.instance").emptyInstance()
32+
end
2733
document:requireNml("banana require path")
2834
document:setBufName("initial buffer name")
2935

3036
-- opens the window
3137
document:open()
38+
-- closes the window
39+
document:close()
3240
```
3341

3442
## Banana require path/structuring plugins
@@ -54,7 +62,3 @@ local document = require('banana.instance').newInstance("pluginName", "initial b
5462
```
5563

5664
An example plugin, [banana-example](https://github.com/CWood-sdf/banana-example), exists that better shows how banana recommends plugins be layed out.
57-
58-
> [!CAUTION]
59-
>
60-
> The wiki is hosted on the main repo. If you would like to make updates, please submit a pr with the changes in the wiki/ folder

0 commit comments

Comments
 (0)