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.

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

Create new documentation and new Website #803

Open
jcubic opened this issue Jul 3, 2022 · 3 comments
Open

Create new documentation and new Website #803

jcubic opened this issue Jul 3, 2022 · 3 comments

Comments

@jcubic
Copy link
Owner

jcubic commented Jul 3, 2022

I have an idea for a new feature for jQuery Terminal

The new documentation should include

  • Introduction
    • Bash and Linux
    • JavaScript
    • jQuery
    • Not for SSH
  • Reference (what is what?)
    • Initialization
    • Terminal Object
    • $.terminal
    • Greetings
    • Interpreter
      • Nested interpreters
    • read() - syntax sugar
    • Parsing Commands
    • Promises and async/await
    • JSON-RPC
    • fetch API examples
    • Options ??? not need for single place
      • dynamic this.option
    • Command Arity
    • echo
    • Text Formatting
    • Responsive Text
      • print cols
      • Figlet
      • Layout / ASCII Canvas
    • more about echo
      • echo Raw HTML (not safe)
      • Emoji
      • Font-Awesome
      • ASCII Table
    • prompt
    • update lines
    • Authentication
      • autologin with sysend
    • masking passwords
    • Executing commands from JavaScript (exec)
    • Server (echo) commands
    • Invoking shortcuts term.invoke_key("CTRL+R") (needs focus)
    • errors / exceptions
    • Render Handler (echo anything)
    • Keymap
    • Other events
    • Buffer / flush / output
    • Command History
    • Reverse History
    • History hints
    • Completion
    • Views (state)
    • Less
      • State
      • Images slices
      • Prism
    • Animations
      • Typing animation
        • Matrix demos
      • Frame animation Nyan Cat
      • echo + update animation
    • Strings (i18n)
    • Dterm
    • Docking Window
    • Exec Hash
    • Completion
    • Integration
      • Vue ???
      • React
      • Angular ???
      • Svelte
      • Solid
      • Webpack Babel Vite
      • TypeScript
    • Wide Characters
    • Style
    • Forms
    • Extending jQuery Terminal via jQuery plugins
  • Getting Started guide (simpler and shorter)
  • Long Tutorial with all the features (Full but gentle introduction)
    • Everything on the Wiki
    • Everything on CodePen
    • Embed CodePen demos
    • Each feature a single document
  • Other Demos (not included elsewhere)
  • API Reference
    • Update all missing stuff

Website specifics

  • Interactive Terminal above the fold
  • Comments section in Nested interpreter (button trigger exec + animation)
  • Interactive Terminal should have more features from 404 page
  • Acknowledge
  • In The wild (on home page)
  • Custom 404 page

Unknown

  • Awesome ASCII
  • Showcase (unusual and best examples)

Tutorials

  • Create Terminal based Chat
  • Hiding commands from users
  • Gaiman tutorial
  • scriptreply (no backspace)
  • Adventure Game
  • Web Worker
  • JWT
  • How to create games that run in terminal
    • "That's the neat part, you don't!" Meme
    • Rouge
    • Snake
    • Tetris
    • How? Find engine

DevOps

  • Disable build when docs change
  • JSON-RPC: Host Simple Dockerized Web App on fly.io for comments (it can be the same PHP code + SQLite)
  • Host ANSI art server code
  • Add GitHub action to build and deploy fly.io and Docusaurus
  • Directory structure
    • docs
      • website (docusaurus)
      • backend (fly.io)
@jcubic jcubic added the feature label Jul 3, 2022
@jcubic
Copy link
Owner Author

jcubic commented Aug 5, 2022

Maybe I can try Docusaurus, Meta just released version 2.0.

@jcubic jcubic added this to the 3.0 milestone Jul 12, 2023
@jcubic
Copy link
Owner Author

jcubic commented Jul 12, 2023

The repo is located here: jcubic/jquery.terminal-docs.

@jcubic jcubic changed the title Create new documentation Create new documentation and new Website May 1, 2024
@jcubic
Copy link
Owner Author

jcubic commented May 1, 2024

When using docusaurus it would be better to just create a whole new website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant