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.

Sign up for GitHub

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

Jump to bottom

Rework #38

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from
Draft

Rework #38

wants to merge 21 commits into from

Conversation

sheridanchris
Copy link
Member

@sheridanchris sheridanchris commented Jun 24, 2024 •
edited
Loading

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

@sheridanchris
Update fable metadata and standalone packages
4f9afb0
@sheridanchris
Update README.md
34c9b55
@sheridanchris
Don't load F# files in the documentation loader
e3a741f
@sheridanchris
Update iframe command to only parse messages from a specific iframe.
59e6c34
@sheridanchris
Remove react-syntax-highlighter dependency
7f0c9b6
@sheridanchris
Rework the docs to use a single editor instance per markdown code block
ac1d297
@sheridanchris
Actually remove the .fsx file from documentation loading logic
37ae80e
@sheridanchris
Small misc improvements
f497b28
@sheridanchris
Remove F# files from table-of-contents.json
c807358
@sheridanchris
Misc styling improvements
0051c73 
Improved compile button
Improved navigation - Added sidebar for navigating between pages.
@sheridanchris
Various improvements and rough playground implementation
2c581da 
* 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
@sheridanchris
Add null check in iframe logic
9aae610
@sheridanchris
go back to a single worker per editor instance
4ee74fd 
other version was buggy... i'm not sure how I didn't catch that.

it will be refactored again at a later date.
@sheridanchris
Misc changes
6c84510 
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
Closed
@sheridanchris
Update npm packages
7b26dea
@sheridanchris
Many UI improvements
68610e2 
* 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)
@sheridanchris
Start styling the UI
7851df1
@sheridanchris
Improve code block rendering
9d463ae
@sheridanchris
Misc improvements to the output logs
07a3ad2
@sheridanchris
a bit more styling
e767e6d
@sheridanchris
start reworking the documentation
8908b63
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Single editor instance per code snippet Dark Mode
1 participant
@sheridanchris