Giter VIP home page Giter VIP logo

docable-notebooks's People

Contributors

chrisparnin avatar dependabot[bot] avatar ssmirr avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docable-notebooks's Issues

ux: introduce edit/operations overlay on hover.

Because a cell, may have more attributes than just the content, we may want a way to edit those attributes. For example, a file block, could contain a user, path, and other attributes to set. It could be useful to introduce a set of operations (๐Ÿ–Š๏ธ edit, |> run, "..." content options menu, o select) to help distinguish operations on a block.

Inspiration:
image

ux: phase out browse file

Browsing and loading a file has many drawbacks... including inability to process associated relative files, such as images, or private tokens (not included in repositories).

Instead, we can phase out browsing files to replace with these other options:

  • import from github (which clones into a space we can manage and control, and thus handle things like images, etc.)
  • load notebooks from notebookdir, much like "examples" are loaded. Jupyter also has the "homedirectory" concept as well: jupyter notebook --notebook-dir D:/my_works/jupyter_ipynbs
  • Provide option to start server from different directory for case where you didn't want to copy/move files into central notebook store. This can replace the browse button for "ad-hoc" stuff for when these other options aren't workable.

Once done, then we complete with:

  • Remove browse button and endpoint.

ux: output look n' feel

The output of a command can be represented in a fixed-sized scrollable box, with a "terminal" look and feel.

Inspiration:

image

css: content containers should have a min. size

Need to have a respectable min. size for the cells, in the event the cell is too small. Furthermore, it should not be too responsive to the size of the content, but constant based a fixed parent width, etc.

image

feat: integrate fluent api design with docable

let cmd = connector.builder
     .command("cd App/ && npm install")
     .expects("Do you want to install", "yes")
     .expects("Do you want to delete X", "no")
     .timeout(5000)
     .persistent();
await cmd.exec()

css/html introduce proper cell structure

docable is incorrectly adding a cell class to the pre block. This is not the responsibility of docable, nor is it the correct structure we need.

Rather than,

<pre class=docable cell>
    <div class=sideannotation>
    <code>
</pre>

Instead we something like this.

<div class=cell>
    <div class=sideannotation>
    <pre class=docable>
       <code>
    </pre>
	<div class=output></div>
</div>

css/html: incorrect structure for cell.

image

The sideannotation should be outside of pre block.

This has implications on layout as the side annotation is a div and may have certain padding, vs. the <code> block is a inline element.

image

assets

keeping misc imgs, gifs, demos here.

PoC

PoC

Update Instructions for pushing local repository to remote repository

When looking at step 2:
Upload your data: git push

It was unclear as to what values were to be inserted for and . It would be really helpful if the instructions were more specific/clear as to what values should be used. My local branch was master while remote defaults to main.

Feature to revert to original cell content

I often want to tinker with a cell to try different arguments, but eventually go back to the cell's original content provided by the tutorial before I proceed. However, there does not seem to be an easy way to do this, so I have to memorize the contents or reload the page.

Undo/redo is broken in some notebooks while editing cells

While editing a cell, if I undo or redo then the prior text is appended to the current text. This does not appear to happen in every notebook. It seems to only happen if you execute the cell between edits. (Chrome 89, Windows 10)

Example:

  1. Go to the git example notebook.
  2. Run the first cell.
  3. Edit the cell to say dir.
  4. Run the cell.
  5. Click into the cell again and undo.

The content is now incorrect. If you redo then it will continue to append the text.

image

ux: hamburger/doner menu and basic pages.

We should have a basic menu (โ˜ฐ) for docable.

Some useful pages, would include:

  • Menu on nav bar.
  • A home page with a list of clickable notebook examples.
  • User's notebooks page (home directory of their notebooks).
  • Settings/Preferences.

Inspiration:

image

POC Roadmap

  • do a tiny bit of clean-up: change format to json5, clean up css rules, look-n-feel.
  • integrate m2html inside main notebook server...
  • work on basic bridge for execution based on "data-attributes" in docable
  • work on executed, look and feel... how is output rendered and displayed.
  • deal with "serialization" ... how are things saved?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.