{"id":27216130,"url":"https://github.com/shira-374/rstpad","last_synced_at":"2025-04-10T04:51:05.918Z","repository":{"id":60612885,"uuid":"74241046","full_name":"shira-374/rstpad","owner":"shira-374","description":"Standalone reStructuredText editor with live preview (native app)","archived":false,"fork":false,"pushed_at":"2023-04-22T15:05:44.000Z","size":586,"stargazers_count":53,"open_issues_count":3,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-24T06:03:37.631Z","etag":null,"topics":["application","cross-platform","editor","live-preview","osx","preview","restructuredtext","rst","side-by-side","standalone","text-editor","windows"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shira-374.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-19T23:10:27.000Z","updated_at":"2024-10-18T11:10:30.000Z","dependencies_parsed_at":"2024-12-20T11:40:10.055Z","dependency_job_id":null,"html_url":"https://github.com/shira-374/rstpad","commit_stats":null,"previous_names":["shira-374/rstpad"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shira-374%2Frstpad","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shira-374%2Frstpad/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shira-374%2Frstpad/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shira-374%2Frstpad/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shira-374","download_url":"https://codeload.github.com/shira-374/rstpad/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161259,"owners_count":21057552,"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":["application","cross-platform","editor","live-preview","osx","preview","restructuredtext","rst","side-by-side","standalone","text-editor","windows"],"created_at":"2025-04-10T04:51:05.476Z","updated_at":"2025-04-10T04:51:05.907Z","avatar_url":"https://github.com/shira-374.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"RSTPad\n######\n\nreStructuredText editor with live preview.\n\n.. image:: screenshot.png\n\n.. contents::\n\n\nFeatures\n********\n\n- live preview with autoscroll\n\n- configurable orientation (horizontal / vertical)\n\n- search \u0026 replace\n\n- toolbar with common elements:\n\n  - headings\n  - bold, italic\n  - inline code\n  - code blocks\n  - horizontal rule\n  - lists\n  - link\n  - image\n\n- inserting highlighted code blocks (Pygments)\n\n  - autocomplete for known lexer names\n\n- built-in help pages\n\n  - syntax cheat sheet\n  - directives\n\n- export to PDF\n\n\n\nKnown limitations\n*****************\n\n- UTF-8 documents only\n\n\nImplementation details\n**********************\n\n- the application contains an embedded Python interpreter\n\n  - Python libraries are located in the application's directory / bundle\n\n- the Docutils library is used to convert RST to HTML on the fly\n\n  - the converstion is done in a separate thread\n  - *resources/preview/docutils_extensions.py* overrides some of the HTML writer's methods to insert additional tags and attributes\n\n- HTML output is displayed using Qt WebEngine\n\n  - external links are delegated to QDesktopServices\n  - autoscroll is implemented in JavaScript\n  - the preview is \"frozen\" during loading and autoscrolling to allow for smooth transitions (a previously rendered frame is used for the duration)\n\n\nCompilation\n***********\n\nPrerequisites\n=============\n\n- QT 5.8 \u0026 Qt Creator\n- Python 2.7 (32bit or 64bit depending on the used compiler)\n- `Pygments \u003chttps://pypi.python.org/pypi/Pygments\u003e`_ (tested with 2.1.3)\n- `Docutils \u003chttps://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/\u003e`_ (tested with 0.13, revision 7975)\n\n\nBuild configuration\n===================\n\n.. NOTE::\n  - The paths used below (such as *C:/python*) are just examples. Use actual paths :)\n  - Use forward slashes in all paths. Omit trailing slashes.\n  - OS X notes and examples assume that Python 2.7 has been installed using Homebrew. Your paths may vary.\n\nCopy *rstpad.local.pro.dist*, name it *rstpad.local.pro* and set the following variables:\n\n- ``PYTHON_LINK``\n\n  - Python linker flags\n  - Windows: ``-LC:/python/libs -lpython27``\n  - OS X: use the `python-config \u003chttp://manpages.ubuntu.com/manpages/precise/man1/python-config.1.html\u003e`_ utility to determine linker flags:\n\n    - ``python2.7-config --ldflags``\n\n- ``PYTHON_INCLUDE_PATH``\n\n  - path to a directory containing Python's header files\n\n    - Windows: ``C:/python/include``\n    - OS X: ``/usr/include/python2.7``\n\n- ``PYTHON_SYS_PATH``\n\n  - path to a directory containing:\n\n    - ``libs.zip`` - the Python standard library as a ZIP archive\n    - ``pygments``, ``docutils`` - library directories (these cannot be inside *libs.zip*)\n    - any *.pyd*, *.dll* and *.so* modules that should be available in a standard Python installation\n\n  - *.pyc* files should be excluded\n\n\nWindows deployment\n==================\n\n#. Use the `Windows Deployment Tool \u003chttp://doc.qt.io/qt-5/windows-deployment.html#the-windows-deployment-tool\u003e`_ with the release binary to fetch required DLLs.\n\n   Example: ``windeployqt.exe --release --no-translations rstpad.exe``\n\n#. Locate and copy the correct ``python27.dll`` file or the application won't work on machines without Python 2.7 installed.\n\n   - possible locations depend on how you've installed Python and on its version:\n\n     - *C:\\\\Windows\\\\System\\\\python27.dll*\n     - *C:\\\\Windows\\\\SysWoW64\\\\python27.dll*\n\n   - make sure you're ussing the correct version (32 vs 64bit)\n\n\nOS X deployment\n===============\n\nUse the `Mac Deployment Tool \u003chttp://doc.qt.io/qt-5/osx-deployment.html#the-mac-deployment-tool\u003e`_ to convert the resulting application into a *.dmg* file:\n\n::\n\n  macdeployqt RSTPad.app -dmg\n\n\nOther platforms\n===============\n\nNot tested yet. You're on your own :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshira-374%2Frstpad","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshira-374%2Frstpad","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshira-374%2Frstpad/lists"}