Skip to content

Rework#38

Draft
sheridanchris wants to merge 21 commits intomainfrom
major-upgrade-1
Draft

Rework#38
sheridanchris wants to merge 21 commits intomainfrom
major-upgrade-1

Conversation

@sheridanchris
Copy link
Member

@sheridanchris sheridanchris commented Jun 24, 2024

Todo:

  • Use a single editor instance per code block. Each code block in markdown will be turned into an interactive editor that will allow you to edit and compile the example.
  • "Edit this page on GitHub" link
  • Implement Playground & "Open in Playground" functionality
  • Implement playground specific examples
  • Improve output logs.
  • Improve tour navigation.
  • Finalize table of contents, rewrite documentation, and remove .fsx scripts
  • Light/Dark mode support
  • Use a single worker and switch to a multi-file model for compiling/parsing (if necessary)
  • Styling

Maybe

  1. Editor Keybinds -- F5 to compile

This will close #27
This will close #39

Improved compile button
Improved navigation - Added sidebar for navigating between pages.
* Use a single worker instance per app
* Add "Edit this page on GitHub" to the bottom of each page
* Add a navigation entry for the "cover" so you can navigate back to it
* Rename "doc page" to "doc entry"
* Create a reusable editor module (init, update, and other logic that is shared between doc pages and playground)
* Create a rough implementation of a "playground" and implement an "open in playground" button for each doc page code editor.
* Fix duplicate tooltip entries
* Update packages

and more
other version was buggy... i'm not sure how I didn't catch that.

it will be refactored again at a later date.
1. Don't use Monaco for non-F# code blocks
2. Remove PicoCSS (will be styling this ourselves)
@sheridanchris sheridanchris mentioned this pull request Aug 6, 2024
* Add the "edit this page on github" link below the page header
* Add light/dark theme toggle functionality
* Improve output window for the documentation pages
* Add toast message for "compiled with warnings"
* Remove any inline styles
* Add sidebar to playground
* Improve html for navbar
* Improve html for documentation sidebar
*  Add class names (get the UI ready for css)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Single editor instance per code snippet Dark Mode

1 participant

Comments