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

Looking for contributions, developers and maintainers #1290

Open
fxha opened this issue Aug 19, 2019 · 52 comments
Open

Looking for contributions, developers and maintainers #1290

fxha opened this issue Aug 19, 2019 · 52 comments

Comments

@fxha
Copy link
Contributor

fxha commented Aug 19, 2019

We recently hit 11k stars after almost two years and more than 1000 commits. We are looking for further contributions to continuous improve Mark Text. Mark Text is a hobby project created by @Jocs and later I (@fxha) joined this awesome project. We both love this project but our time is also limited to maintain and develop Mark Text. There are a lot of thing to do that Mark Text becomes a stable but also a fast and more performant editor.

If you are interested let us know and please comment on this issue. We are happy to invite active contributions that are working on this project, whether developing new features or help with issues. You should have JS knowledge and need an enabled two-factor authentication account. To summarize, we are looking for:

  • Supporting members to help with issues and review PRs.
  • Developers/Maintainers to develop new features and fix bugs (and organisational stuff like project management and releases).
  • Or maybe both, depending on your available free time.

There are other things that you can do to improve Mark Text:

  • Let us know you opinion about Mark Text, missing features and report bugs and problems.
  • Participate in the internationalization of Mark Text and optimize or write the end user documentation. These documentation will be available via GitHub but also on our website. We'll open another issue for this if localization was added.
  • 👍 features you like and discuss with us about upcoming changes and features.

Upcoming and necessary changes:

In the next time we need to make some necessary changes on Mark Text's core and refactor even more files.

  • Basic end-user (features, available markdown specs., ...) and developer documentation.
  • Further improvements and feature implementation.
  • Refactoring the core of Mark Text called muya. This is urgently required to improve the data structure but also to improve performance and reduce memory usage. This would allow us to implement a flexible API for plugins but also improve the communication via an editor API (@Jocs is assigned for this).

You can find all planned "core" features here and a lot more via the issue tracker.

Many thanks (in advance) to everyone who giving their time to contribute to Mark Text and help this project!


Mark Text is still in development, many thing will change and feature will be added but our philosophy is to keep things clean, simple and minimal. For example our side bar and tabs: these two panels provide a lot of functionality but don't disturb the user if it's not needed. We'll add more and more feature, maybe extended by plugins, that can be activated via settings to improve Mark Text. So we allow everyone to customize Mark Text for it needs and provide a minimal default interface.

@fxha fxha pinned this issue Aug 19, 2019
@fxha
Copy link
Contributor Author

fxha commented Aug 19, 2019

However, this doesn't mean that Mark Text is unmaintained but @Jocs and I are currently a little bit busy. Big changes and features cannot be expected during the next month and following month and also issues processing may take some time.

@DutchPete
Copy link

@fxha

We'll add more and more feature, maybe extended by plugins, that can be activated via settings to improve Mark Text. So we allow everyone to customize Mark Text for it needs and provide a minimal default interface.

1 thing that would also help easy customisation is a user css file. Every user can then customise MT to his own taste, within limits of course. Certain browsers have this (e.g. Firefox), and apps too (e.g. Typora). The latter also has a themes folder where the user can add downloaded themes or insert themes he/she made himself. VNote has an ini file that can be edited by the user.

@Jocs
Copy link
Member

Jocs commented Aug 19, 2019

@DutchPete Maybe we might do better, we can download the theme and plugin you want directly in the app, similar to VSCode, uninstall it when you don't need it, you don't need to manually copy and paste it.
For plugins, what we can think of at the moment is to support storage to google drive, one drive, etc., or to add plugins such as vim shortcuts binding.

@KancerEzeroglu
Copy link

Hi @fxha ,

I would like to contribute to your project. I'm a software developer and I have frontend and backend skills. Where should I start? :)

@Jocs
Copy link
Member

Jocs commented Sep 2, 2019

@KancerEzeroglu Thank you very much for your willingness to contribute code to Mark Text. You can look at the issues labeled as bug, try to solve them, and submit the PR.

If you encounter any problems in the process, you can discuss them in issue or PR.

@KevalS
Copy link

KevalS commented Sep 23, 2019

Hello Guys, I have good Frontend skills and would like to contribute to the project by solving issues. Thank you

@Jocs
Copy link
Member

Jocs commented Sep 23, 2019

@KevalS Thank you very much you are will to solve issues, you can look up the issues which labeled good to first , bug or help wanted, you can contact me or @fxha when you have any question.

@DutchPete
Copy link

I offered to donate but have not heard back. I do not want to use PayPal or a credit card, but if you have a European bank account I'll be happy to make a transfer, provided you give the exact name of the account and the IBAN.

@piaoyidage
Copy link

Mark Text is very impressive. I want to contribute to this project.

@Jocs
Copy link
Member

Jocs commented Oct 21, 2019

@piaoyidage You can start with these documents https://github.com/marktext/marktext/wiki

@piaoyidage
Copy link

@Jocs OK,thanks for your response.

@skyblue002
Copy link

@Jocs Do you have further documentation on themes? I'd be interested in creating my own. I know user-defined themes are planned for v0.17.0. I don't mind compiling MarkText myself afterwards to include that theme in my build. I'd even share it if it turned out well. I'm just not sure if you're planning on changing how themes are made to allow for users to create them. Let me know if you have more information. I didn't see any on this in the Wiki.

@Jocs
Copy link
Member

Jocs commented Nov 5, 2019

Do you have further documentation on themes? I'd be interested in creating my own. I know user-defined themes are planned for v0.17.0. I don't mind compiling MarkText myself afterwards to include that theme in my build. I'd even share it if it turned out well. I'm just not sure if you're planning on changing how themes are made to allow for users to create them. Let me know if you have more information. I didn't see any on this in the Wiki.

Sorry, we currently do not have any document about theme/custom theme, there even no clear plan how to implement the custom theme. I think you can refer the files in the folder with path src/renderer/assets/themes. all Mark Text themes except the light are in this folder, the light theme is in src/renderer/assets/styles path. you can change the files in this folder to custom you theme, but we maybe move this folder to other place in v0.17.0.

@skyblue002
Copy link

Thank you, @Jocs I'll check out those files. Could you also let me know how to add another font as an option for the editor? (I'll keep in mind that these things may change in v.0.17.0, thank you for the warning.)

Just an idea, but if the theme colors were consolidated, that would make it easier to write a GUI for. For example, you could ask the user what colors they want for the foreground, background, and highlight colors for the sidebar, then for the editor area. This is just six colors total. Based on the colors chosen, the code could evaluate whether the user picked a light or dark theme for the sidebar and the editor area. Then, other colors can be extrapolated from that. For example, the background color when hovering the mouse over a link in the sidebar is darker than the background in a light theme, but lighter if the theme is dark. The rest of the colors for the theme can be extrapolated like this, simplifying the process until either a more complex GUI is made to handle all the aspects of the theming, or code is written to take in themes in a form that users can easily write themselves (i.e. a simple .css file).

Alternatively, you could create a base light, medium (gray), and dark theme (either for the whole app or for the sidebar and editor each individually), then allow the user to choose what color they want the highlights to be (e.g. Cadmium Light has green highlights). This would the users to feel like they can make choices on how it looks while keeping the coding and GUI changes to a minimum, compared to the previous idea.

Those are just some thoughts. I hope you find them helpful. You've done a great job on the app! Thank you for sharing it with us. 😄

@stevekeol
Copy link

wow, it's the perfect markdown editor that I'm have being searched for long time. thanks for everybody

@ctjlewis
Copy link

A truly terrific piece of software. I can't wait to see what it looks like in 2 years and plan to sink time into contributing over the coming months.

@ssimontis
Copy link

I am interested in contributing. Back-end is more my forte, but I have been looking for an opportunity to get involved with Electron app development.

Is there a contributor agreement that needs to be signed before I can start taking on issues? I look forward to helping out with this awesome program!

@fxha
Copy link
Contributor Author

fxha commented Nov 13, 2020

Thank you for your interest in Mark Text. Any contribution is very much appreciated!

I found that there are some pull request opened nearly one year, and some issues yet not resolved. [...] I suggest to invite some contributors to join the project, also I'd like to be one of the team and make the project goes far.

@xinpingwang Unfortunately, Mark Text is currently not maintained and we currently haven't time for it. We welcome all contributors and try to answer issues and review PR's from time to time.

Is there a contributor agreement that needs to be signed before I can start taking on issues? I look forward to helping out with this awesome program!

@ssimontis No, there's no CLA but you need to provide your code under the MIT license and have the right to do so.

@Drallas
Copy link

Drallas commented Feb 3, 2021

I'd love to help, i can do some light coding and other things necessary. I will go trough the issues and see where i can be useful.

@csc-chicken
Copy link

recently I see no active contributor, maybe some developer need help.

(sorry I write c# and c++ and I never write javascript)

@AnClark
Copy link

AnClark commented Dec 11, 2021

Now I'm implementing i18n support. Everything is working in progress. I'd love to help.

Here's my repo: https://github.com/anclark/marktext/tree/i18n-alpha-support

@Indosaram
Copy link

I am also really impressed by this project. I'd like to contribute! Thank you for maintaining this project.

@loyukfai
Copy link

loyukfai commented Jan 5, 2022

So, is this still being maintained? Just wondering...

@meanMonk
Copy link

Mark Text is simply awesome, I would like to be part of the community to contrinute to development and PR reviewing.

@Jocs
Copy link
Member

Jocs commented Jan 12, 2022

Mark Text is simply awesome, I would like to be part of the community to contrinute to development and PR reviewing.

@meanMonk PR is welcomed and also hope for helping review issues and improve documentation.

@moksamedia
Copy link

moksamedia commented Feb 22, 2022

I'm interested. Happy to help with bug fixes or develop new features as I have time. Let me know what I can do!

@kiyoka
Copy link
Contributor

kiyoka commented Mar 13, 2022

I am primarily a server-side engineer.
At work, I use Mark Text to write procedure manuals with screen captures.
I would like to contribute new features and bugs I find in my workflow.

@StephenChips
Copy link

I'd like to get involved. I am a 2yr+ front-end engineer with Vue.js background. I think I can do tiny things for this project.

@QuinsZouls
Copy link

QuinsZouls commented Jun 24, 2022

I would like to contribute to development and PR reviewing, I'm working on i18n

@DutchPete
Copy link

Is this project still alive?

Surely there is a beautiful opportunity to fill the void left by Typora going commercial and not having a free version anymore.

@fxha
Copy link
Contributor Author

fxha commented Jul 2, 2022

MarkText has no active maintainers and @Jocs (the owner) took a break. Unfortunately, I cannot coordinate with @Jocs about the future and his plans because I cannot reach out to him for the last months.
For my part, I enjoyed the work on this hobby-project and still have write access (non-admin) to the organisation but cannot push on protected branches like develop or merge my own PRs. Which lead to a tough decision to step down as maintainer and move on.

I can only speculate cautiously about the future of MarkText, but I guess that no further releases are planned for the near future. At the same time, I very much hope this project will be continued. We had planned and started internal changes on the core engine to improve the overall performance and extensibility. For the time being, I'm thankful for all contributors and users which use, built and improved MarkText and wish you all the best.

@DutchPete
Copy link

@fxha: thank you so much for responding. I had a feeling this is what was happening.
Luckily it is still possible to use the penultimate beta version of Typora, so I have reverted back.
I also wish you all the best for the future.

@tweinreich
Copy link

@fxha: thank you for this update. I am sorry to hear that the future for MarkText is unclear and want to thank you for all the effort you put into building and maintaining this app!

I wish you all the best👍

@chinayangxiaowei
Copy link

I want to do something. I try to make the resource package Chinese, fix a bug that picgo can't find under the Mac, and package and publish it on my own GitHub. The effect is OK, but it would be better to modify and implement it from the source code, but I don't have permission.

@StephenChips
Copy link

StephenChips commented Sep 1, 2022

@fxha

Can you share your plans and completed tasks on refractoring the core engine, as I have already had some rough ideas about it, and want to get involved.

P.S. Have you ever considered continuing this project on a forked repository if the project have been stalled for a long time?

@hCKbJf6MCesgWSPH
Copy link

hCKbJf6MCesgWSPH commented Dec 24, 2022

@fxha Any reason why not just fork and continue this project (can always be merged back to this if original dev returns later)? To wait a few months until the original dev replies is ok and pays respect, but it has been like a year really by now or even more? Many pull requests and issues have piled up as well. I personally (and many others) need the collapsible content and there's no reason not to have it, also the issue has been open for like 2 years now. Add deeper nesting than 1-level later if it's hard to implement, 1-level collapsible content would much better than nothing.

@DutchPete
Copy link

@hCKbJf6MCesgWSPH Mark Text is dead: fact.

Suggestion: try Obsidian, you won't regret it, you'll be blown away by the features and customizability, it is unrivaled, and it is free.

@axelrindle
Copy link

Is there an active fork around somewhere?

@syockit
Copy link

syockit commented Feb 27, 2023

@DutchPete Just for clarification: According to its EULA, Obsidian is free for personal use. If you use it for commercial activity, you actually need to get a commercial license (except if you are a sole proprietorship).

@Teloshav
Copy link

Teloshav commented May 8, 2023

Ah... It's a shame to see this happen to MarkText.

I have pretty much no skills in what's required to try make and maintain my own fork of the project, but I think I'll try see what I can learn about this cool app in my spare time, and try to fix any bugs I find/seen from other people.

Like with everything else I'm trying out, this will be a great opportunity for me to learn a thing or two!

Thank you to the original developers and maintainers for making this fantastic app, I've been using it for a very small amount of time and have completely fallen in love with it!

  • Teloshav

@suiyun39
Copy link

@Jocs @fxha
I can help with add i18n, update vue3 and update build system.
But this project does not appear to have an active manager currently, How can I get started and discuss proposals?

@Teloshav
Copy link

@NoDocCat

I think it was fxha who would respond more often as Jocs has gone MIA from what I recall (don't quote me on that, all I know is that one of the developers stopped communicating some time ago now). You've already pinged them, so hopefully you'll get a response from one of them soon!

On an unrelated note, I realised that I have too much going on to try help out significantly, which is a shame. :(

  • Teloshav

@jacobwhall
Copy link

Is there an active fork around somewhere?

@axelrindle I'm intermittently maintaining a fork here, merging in PRs from the main repository that look good to me. If anyone would like to collaborate on this with me, please reach out!

One of the most common things I see in PR comments are requests for builds for MacOS and Windows with bugs patched. I only have experience building for Linux, but if we could do multiplatform builds with GitHub Actions for each release, that would meet a real demand.

@axelrindle
Copy link

@jacobwhall Sounds awesome, I'd like to help! electron-builder should be able to handle all the hard stuff.

@jacobwhall
Copy link

electron-builder should be able to handle all the hard stuff.

@axelrindle sweet, yeah it looks like electron-builder is already integrated into the build process, so targeting other platforms might be easier than I thought! I just opened jacobwhall#2 to track this issue.

@growdigital
Copy link

@hCKbJf6MCesgWSPH Mark Text is dead: fact.

Suggestion: try Obsidian, you won't regret it, you'll be blown away by the features and customizability, it is unrivaled, and it is free.

I've had a look around, Zettlr seems to have similar functionality and is open source :)

@stefnotch
Copy link
Contributor

Zettlr sadly has one issue that I consider to be a major design flaw. The HTML exports will look very different from the Markdown document, unless one always keeps the Markdown newline rules in mind.

Zettlr/Zettlr#1367

@dmytroshytikov
Copy link

dmytroshytikov commented Sep 11, 2023

I wonder how to become a contributor.

I am not superb, but it would be an interesting task. And I really like MarkText, so it would be great to improve it.

@dmytroshytikov
Copy link

MarkText has no active maintainers and @Jocs (the owner) took a break. Unfortunately, I cannot coordinate with @Jocs about the future and his plans because I cannot reach out to him for the last months. For my part, I enjoyed the work on this hobby-project and still have write access (non-admin) to the organisation but cannot push on protected branches like develop or merge my own PRs. Which lead to a tough decision to step down as maintainer and move on.

I can only speculate cautiously about the future of MarkText, but I guess that no further releases are planned for the near future. At the same time, I very much hope this project will be continued. We had planned and started internal changes on the core engine to improve the overall performance and extensibility. For the time being, I'm thankful for all contributors and users which use, built and improved MarkText and wish you all the best.

It is a nice and clear editor. I hope it will continue developing.

@H4kur31
Copy link

H4kur31 commented Oct 5, 2023

It seems that the focus has been placed on the Muya project.

@YutingZhang
Copy link

A link to Muya: https://github.com/marktext/muya
I feel this is a good move as the new project enable to embed the editor in other applications.

@H4kur31
Copy link

H4kur31 commented Dec 4, 2023

I'm currently contributing code and gaining experience for another similar project. In contrast to Marktext, this one is solely browser-based without a dedicated client (akin to Muya). However, I still use MarkText in my daily routine simply because I only need a '.exe' for writing MD. I prefer not to go through the process of installing via a package manager, configuring JSON preferences, and writing HTML code to import JS files as one does for a project. I believe many others share this sentiment. The MarkText development team has shifted focus from MarkText to Muya, hinting at a potential future release of MarkText 2.0 through a client code overhaul. It appears to be a lengthy process, and before that happens, some bugs in MarkText might force me to abandon using the software.

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