{"id":13415566,"url":"https://github.com/vkbo/novelWriter","last_synced_at":"2025-03-14T23:30:54.598Z","repository":{"id":36197887,"uuid":"149890803","full_name":"vkbo/novelWriter","owner":"vkbo","description":"novelWriter is an open source plain text editor designed for writing novels.","archived":false,"fork":false,"pushed_at":"2025-02-23T21:35:03.000Z","size":39738,"stargazers_count":2291,"open_issues_count":120,"forks_count":126,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-03-11T23:02:53.957Z","etag":null,"topics":["editor","linux","macos","meta-data","novels","novelwriter","python","qt5","synopsis","text-editor","windows","writing-novels"],"latest_commit_sha":null,"homepage":"https://novelwriter.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vkbo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"ko_fi":"jadzia626"}},"created_at":"2018-09-22T15:40:59.000Z","updated_at":"2025-03-10T11:01:09.000Z","dependencies_parsed_at":"2022-07-16T01:00:42.820Z","dependency_job_id":"9dba8a0d-0dcc-4c6f-9a8f-5b9b2f206bcb","html_url":"https://github.com/vkbo/novelWriter","commit_stats":{"total_commits":4835,"total_committers":19,"mean_commits":"254.47368421052633","dds":"0.014064115822130296","last_synced_commit":"cc5cd5006562ab368d594e51a039d773f5162d87"},"previous_names":[],"tags_count":131,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkbo%2FnovelWriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkbo%2FnovelWriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkbo%2FnovelWriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkbo%2FnovelWriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vkbo","download_url":"https://codeload.github.com/vkbo/novelWriter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243663308,"owners_count":20327299,"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":["editor","linux","macos","meta-data","novels","novelwriter","python","qt5","synopsis","text-editor","windows","writing-novels"],"created_at":"2024-07-30T21:00:50.347Z","updated_at":"2025-03-14T23:30:54.593Z","avatar_url":"https://github.com/vkbo.png","language":"Python","readme":"# novelWriter\n\n[![Linux](https://github.com/vkbo/novelWriter/actions/workflows/test_linux.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_linux.yml)\n[![Windows](https://github.com/vkbo/novelWriter/actions/workflows/test_win.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_win.yml)\n[![MacOS](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml)\n[![Flake8](https://github.com/vkbo/novelWriter/workflows/flake8/badge.svg)](https://github.com/vkbo/novelWriter/actions)\n[![CodeCov](https://codecov.io/gh/vkbo/novelWriter/branch/main/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter)\n\n\u003cimg align=\"left\" style=\"margin: 0 0 4px 0;\" src=\"https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/novelwriter_readme.png\"\u003e\n\nnovelWriter is a plain text editor designed for writing novels assembled from many smaller text\ndocuments. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data syntax\nfor comments, synopsis, and cross-referencing. It's designed to be a simple text editor that allows\nfor easy organisation of text and notes, using human readable text files as storage for robustness.\n\nThe project storage is suitable for version control software, and also well suited for file\nsynchronisation tools. All text is saved as plain text files with a meta data header. The core\nproject structure is stored in a single project XML file. Other meta data is primarily saved as\nJSON files.\n\nFor more details, and how to install and use novelWriter, please see the main website and\ndocumentation.\n\n**Project Links**\n\n* Website: [novelwriter.io](https://novelwriter.io)\n* Documentation: [docs.novelwriter.io](https://docs.novelwriter.io)\n* Internationalisation: [crowdin.com/project/novelwriter](https://crowdin.com/project/novelwriter)\n* PyPi Project: [pypi.org/project/novelWriter](https://pypi.org/project/novelWriter)\n* Social Media: [fosstodon.org/@novelwriter](https://fosstodon.org/@novelwriter)\n\n## Sponsors\n\n\u003ctable style=\"border: none;\"\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\u003cimg align=\"left\" style=\"height: 25px;\" src=\"https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/signpath_logo.png\"\u003e\u003c/td\u003e\n  \u003ctd\u003eFree code signing on Windows provided by \u003ca href=\"https://about.signpath.io/\"\u003eSignPath.io\u003c/a\u003e, certificate by \u003ca href=\"https://signpath.org/\"\u003eSignPath Foundation\u003c/a\u003e.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## Implementation\n\nnovelWriter is written with Python 3 (3.10+) using Qt6 and PyQt6 (6.4+), and is released on\nLinux, Windows and macOS. It can in principle run on any Operating System that also supports Qt,\nPyQt and Python.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"80%\" src=\"https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/screenshot.png\"\u003e\n\u003c/p\u003e\n\n## Project Contributions\n\nPlease don't make feature pull requests without first having discussed them with the maintainer.\nYou can make a feature request in the issue tracker, or if the idea isn't fully formed, start a\ndiscussion on the discussion page. Please also don't make pull requests to reformat or rewrite\nexisting code unless there is a very good reason for doing so.\n\nFixes and patches are welcome. Contributions related to packaging and installing novelWriter will\nalso be appreciated, but please make an issue or a discussion topic first. Before contributing any\ncode, please also read the full\n[Contributing Guide](https://github.com/vkbo/novelWriter/blob/main/CONTRIBUTING.md).\n\nProject credits are available in [CREDITS.md](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md).\n\n**Note:** As of April 2024 only pre-releases are made from the `main` branch. Full releases are\nmade from the `release` branch. So if you're submitting a fix to a current release, **including\nchanges to documentation**, they must be made to the `release` branch.\n\n### Translations\n\nNew translations are always welcome. This project uses Crowdin to maintain translations, and you\ncan contribute translations at the [Crowdin project page](https://crowdin.com/project/novelwriter).\nIf you have any questions, feel free to post them to the\n[Translations of novelWriter](https://github.com/vkbo/novelWriter/issues/93) issue thread.\n\nFor more details, and how to use Qt Linguist for translations, see the\n[i18n instructions](https://github.com/vkbo/novelWriter/blob/main/i18n/README.md).\n\n## Licence\n\nThis is Open Source software, and novelWriter is licenced under GPLv3. See the\n[GNU General Public License website](https://www.gnu.org/licenses/gpl-3.0.en.html) for more\ndetails, or consult the [License](https://github.com/vkbo/novelWriter/blob/main/LICENSE.md)\ndocument. Bundled assets and their licences are listed in the\n[Credits](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md) document.\n","funding_links":["https://ko-fi.com/jadzia626"],"categories":["Editor/IDE/Debugger","Python","By Industry","Table of Contents","阅读与写作工具","By Language","Reading and Writing Tools","macos","写作与编辑环境"],"sub_categories":["Data Science","Text Editor","写作","Python","Writing","笔记与知识管理软件"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkbo%2FnovelWriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvkbo%2FnovelWriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkbo%2FnovelWriter/lists"}