-
Notifications
You must be signed in to change notification settings - Fork 5
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
Update docs #6
base: master
Are you sure you want to change the base?
Update docs #6
Conversation
- Add expandable gif demos for multiple cursor - Add examples for themes to look at - Small whitespace fixes - Add faq section with the original inspiration and idea of Lapce
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer if all presented editors looked the same as the ones in docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, updated
development/architecture.md
Outdated
The frontend uses [Druid](https://github.com/linebender/druid) for the GUI of Lapce. Druid is a data first GUI framework. And all the state and logic are in `lapce-data` sub crate, e.g., file buffers, editor tabs, cursor, etc. The UI widgets tree, layout, and rendering logic are in `lapce-ui` sub crate, including all the UI related stuff, e.g., keyboard and mouse events, file dialogs, context menus etc.  | ||
The frontend uses [Floem](https://github.com/lapce/floem) for the GUI of Lapce. All the state and logic are in `lapce-data` sub crate, e.g., file buffers, editor tabs, cursor, etc. The UI widgets tree, layout, and rendering logic are in `lapce-ui` sub crate, including all the UI related stuff, e.g., keyboard and mouse events, file dialogs, context menus etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to wait until we release floem version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, my bad - fixed.
development/building-from-source.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer not adding docs from repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My thought with this was to add some docs for getting started on development. It felt like there needed to be more documentation for this, but I was concerned how it would keep up-to-date with the lapce/docs directory.
I could also create a simple page that points to docs in the Lapce directory - otherwise, if it really shouldn't be included at all I can remove all of those docs.
development/plugin-development.md
Outdated
It should publish the plugin to the registry. | ||
|
||
## Examples | ||
There are lots of good examples from the community to base a plugin or theme. All can be found at [the regisry](https://plugins.lapce.dev/), but a few examples include: | ||
|
||
The [Template](https://github.com/lapce-community/lapce-volt-template) "plugin". | ||
Be sure to include a README.md with links back to the repo! | ||
|
||
The [python](https://github.com/superlou/lapce-python) plugin. | ||
|
||
The [Go](https://github.com/lapce-community/lapce-go) plugin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer to not include this section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, removed.
- gifs should be the whole Lapce window now - Changed back to specifying Druid: Lapce still uses Druid vs. Floem
lapce/docs