{"id":13447378,"url":"https://github.com/raphaelcruzeiro/jquery-notebook","last_synced_at":"2025-05-16T00:06:45.266Z","repository":{"id":13344226,"uuid":"16031396","full_name":"raphaelcruzeiro/jquery-notebook","owner":"raphaelcruzeiro","description":"A modern, simple and elegant WYSIWYG rich text editor.","archived":false,"fork":false,"pushed_at":"2020-04-13T20:20:10.000Z","size":351,"stargazers_count":1687,"open_issues_count":57,"forks_count":207,"subscribers_count":67,"default_branch":"master","last_synced_at":"2025-05-14T02:58:29.775Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raphaelcruzeiro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-18T18:36:35.000Z","updated_at":"2025-03-24T15:41:57.000Z","dependencies_parsed_at":"2022-08-25T15:01:55.266Z","dependency_job_id":null,"html_url":"https://github.com/raphaelcruzeiro/jquery-notebook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelcruzeiro%2Fjquery-notebook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelcruzeiro%2Fjquery-notebook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelcruzeiro%2Fjquery-notebook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raphaelcruzeiro%2Fjquery-notebook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raphaelcruzeiro","download_url":"https://codeload.github.com/raphaelcruzeiro/jquery-notebook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442854,"owners_count":22071878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T05:01:15.884Z","updated_at":"2025-05-16T00:06:40.251Z","avatar_url":"https://github.com/raphaelcruzeiro.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Rich text editor","Animation","基于 JQuery","Editors","Editors [🔝](#readme)","编辑器","JQuery Based"],"sub_categories":["Editors","Runner","运行器","运行器e2e测试"],"readme":"# jQuery-Notebook\n**A simple, clean and elegant WYSIWYG rich text editor for web aplications**  \n**Note:** Check out the fully functional demo and examples [here](http://raphaelcruzeiro.github.io/jquery-notebook/).\n# Usage\n\n**Prerequisites:** jQuery-Notebook's default styling [FontAwesome](http://fontawesome.io/) draw the icons on the _context bubble_.\nYou can install both FontAwesome and jQuery-Notebook through bower with the following command:\n\n`bower install jquery-notebook font-awesome`\n\nAlternatively, you can download FontAwesome [here](http://fontawesome.io/assets/font-awesome-4.0.3.zip) or link to the CDN.\n\n##### Add the FontAwesome css and jQuery-Notebook css to you page _head_:\n\n```html\n\u003clink href=\"http://netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css\" rel=\"stylesheet\"\u003e\n\u003clink rel=\"stylesheet\" type=\"text/css\" href=\"src/js/jquery.notebook.css\"\u003e\n```\n\n##### Add jquery and jquery-notebook.js to your page:\n\n```html\n\u003cscript type=\"text/javascript\" src=\"src/js/libs/jquery-1.10.2.min.js\"\u003e\u003c/script\u003e\n\u003cscript type=\"text/javascript\" src=\"src/js/jquery.notebook.js\"\u003e\u003c/script\u003e\n```\n\n##### Create the editor:\n\n```html\n\u003cdiv class=\"my-editor\"\u003e\u003c/div\u003e\n```\n\n```js\n$(document).ready(function(){\n    $('.my-editor').notebook();\n});\n```\n\nThat's it!\n\n# Available Commands\n\n- Ctrl/Command B - Bold\n- Ctrl/Command I - Italic\n- Ctrl/Command U - Underline\n- Ctrl/Command F1 - Header 1\n- Ctrl/Command F2 - Header 2\n- Ctrl/Command Z - Undo\n\n# Options\n\nThese are the supported options and their default values:\n\n```js\n$.fn.notebook.defaults = {\n    autoFocus: false,\n    placeholder: 'Your text here...',\n    mode: 'multiline', // multiline or inline\n    modifiers: ['bold', 'italic', 'underline', 'h1', 'h2', 'ol', 'ul', 'anchor']\n};\n```\n\n# Events\n\n- __contentChange__:\nFires every time the editor's content is modified:\n\n```js\n// Using jQuery:\n$('.my-editor').on('contentChange', function(e) {\n    var content = e.originalEvent.detail.content;\n});\n\n// OR using the event directly:\nvar editorDomElement = $('.my-editor').get(0);\neditorDomElement.addEventListener('contentChange', function(e) {\n    var content = e.detail.content;\n});\n```\n\n# Contributing\n\nWe use Github Issues to do basically everything on this project, from feature\nrequest to bug tracking. There are a few issues marked as _easy picking_.\nThese issues are ideally suited for someone who wants to start contributing as\nthey are fairly simple.\n\nTo contribute to this project just fork the repository,\ncreate a branch with a descriptive but brief name and send a pull\nrequest when ready. There is __no need__ to squash your commits\nbefore sending a pull request. After a few accepted and merged pull requests you can\nrequest push rights to the repository if you want to.\n\nPlease use 4 spaces for indentation. Any pull requests that has any JavaScript\ncode with a different indentation will be rejected.\n\n\n\n# Contributors\n[raphaelcruzeiro](https://github.com/raphaelcruzeiro/)  \n[otaviosoares](https://github.com/otaviosoares/)  \n[slahn](https://github.com/slahn)  \n[TrevorHinesley](https://github.com/TrevorHinesley)  \n[cbartlett](https://github.com/cbartlett)  \n[penman](https://github.com/penman)  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraphaelcruzeiro%2Fjquery-notebook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraphaelcruzeiro%2Fjquery-notebook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraphaelcruzeiro%2Fjquery-notebook/lists"}