The above image doesn't show the correct readme.so logo.

@katherinepeterson , as discussed previously , to work on "clearAll" functionality and other things , local storage should be in place . It's even relevant and meaningful to implement before we implement the "adding a new custom section" functionality . I'll take this up.

The markdown for feedback in data/section-templates.js is empty

I saw that we should be able to add support to i18n with the following dependency. Thoughts on adding this to the site?

-user can upload an existing readme and edit

• ideally we would parse the headers and create custom sections for what they already have

@katherinepeterson , i think its better to keep authors and acknowledgement sections as separate , as they kinda serve a bit different purpose , also one unassumed benefit would be that the section name also would not be unnecessary too long which might also avoid bloating UI alignment in future .

My understanding on purpose of sections :
Authors -- can be used mention the key authors of the codebase/project
Acknowledgements - also mean crediting other libs , projects , of which help/inspiration was taken to build a project . One such example here : https://github.com/othneildrew/Best-README-Template

Allow user to add custom sections

• They should be able to name the section and edit the contents

@katherinepeterson , after we have basic PR merged for the local-storage , we need to make our section-slugs modifications also be refreshed and updated on browser refresh . Currently they pickup static data from section-templates.js

This might just be a personal preference, but the whole body overflows and a scrolling bar is seen:

And since the left side menu is already a scrolling one, I don't think the whole body should scroll too.
I see the three elements have max-h-screen to be as tall as the screen, but since there is a header on the top, and some text as well, the overflowing happens.

Hi @katherinepeterson ,
I can add the Turkish language support 🇹🇷

Currently, on any touch devices, when you navigate to the editor it just shows a message saying that this site is optimized for desktop.

Navigating the website with Tab key skips the translation links in <LanguageDropDown />.

display: none is skipped from Tab cycle. So, we could use scale or opacity, along with group-hover: and focus-within:. These properties can also be animated, so we could add a transition.

Feedback from Twitter:

the text areas won't accept the (crtl + cmd + space) mac shortcut for bringing the emojis menu

Feedback from Twitter:

— while using editor i selected multiple lines and pressed TAB key ( for indentation ) those lines got erased.
— then i tried undoing ( cmd + z ) but editor didn't had undo support for that change.

The html lang attribute does not change automatically when languages change.

Hi @katherinepeterson , i can add italian language support.

Code to embed:

<a href="https://www.producthunt.com/posts/readme-so?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-readme-so" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=291731&theme=light" alt="readme.so - Easily create the perfect readme for your project | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

Currently the UI in the landing page screenshot is out of date (the editor changed)

Hi, I can add the portuguese translation :)

Currently the page has no SEO Support

Each language should be written in their original/ local language in every language pages of the website. If I am in the website which is Spanish as a Turkish person, I should see "Türkçe" word as an option in the language dropdown not "Turco" which is called by Spanish people. Because I may not be able to know the definition of "Türkçe" in Spanish. So here is my advices below:
Every languages should be the same in all language pages.
English,
Français,
Español,
Italiano,
Türkçe

If you agree with me I can fix it.

Hi! I can add chinese language.

If the end user does not have nextjs installed before running the project:

npm install next or npm update next <--- Most likely, you should just be able to instead of installing as it should already be installed.

Then

run npm run dev and you should be set to go with the following messege ready - started server on 0.0.0.0:3000, url: http://localhost:3000. You can also just hold ctrl+left click the url: http://localhost:3000 which will open up in a tab in your browser.

When a section is disabled , then the editor is also not visible , so we need to hide the dark mode toggle button as well .

Sometimes I accidentally highlight the text of the section buttons when I'm trying to drag and drop

The current page ahas no title and reads as https://readme.so. Plan to add a proper title such as readme.so - Easiest Way to Create A README

I have seen a couple of A11y issues by testing the readme.so via Lighthouse, And I have fixed couple of them you can take a look at feat/improve-a11y branche.

As a user, I should be able to view the full readme at once in the editor pane if I want to instead of just separate sections.

I suppose we can have one more item in the section tab named Full View (or something else, I am not good with naming :p) which would preview the whole readme in the Editor pane.

I am not entirely sure how big of a task this would be or will need how the data is managed entirely but it feels like this should be possible and might increase user experience for the people who like having a full view before they download their hours of work creating an awesome readme 😉

Rather than dragging the section button, the drag handle icon is picked up instead. When this is released, I can move the session normally.

Video demonstration:

Version info

Firefox 87.0
MacOS Big Sur 11.2.3 (20D91)

Hey @katherinepeterson , pretty trivial feature but I think it will be nice to support adding markdown emojis within the app as I've noticed that quite a number of READMEs have them (including some of mine haha). Let me know what you think, thank you.

Adding a git hook using husky to run a pre commit check by running prettier --write to ensure all files are formatted with prettier before being pushed to the remote repository.

Currently , when a user wants to reset its readme file's content (i.e start from scratch with just the 'title and description' template) , he/she has to refresh the entire page in chrome/any browser . Currently we can delete individual sections by clicking on delete icon one by one , but can't delete all at one . So , should we support a "clear all" to clean up all sections at once or let us just browser refresh do it for now ? Also , is the browser refresh supposed to clean-up all the used sections while a user is creating a readme , and in middle of it the progress is lost if he just refreshes the browser (if he didn't backed up the document by downloading in-between) ? While working with swagger editor online for designing APIs i have experienced , it saves the state for the current session of user from local storage with any custom changes , even if he refreshes browser as here : https://editor.swagger.io/ .

For example:

How can you do this? 👆

<details>
<summary>What is my problem?</summary>
<br> I don't know LOL </br>
<ul>
     <li>One</li>
     <li>Two</li>
</ul>
</details>

Source: Dropdowns Gist
Thank You, @citrusui! 🤩

Hello :) I can add the filipino translation 🇵🇭. Salamat

Pull request #88

Add a markdown guide for reference that shows the syntax for all basic markdown components.

@katherinepeterson after having look at raw-markdown-preview-feature added by @jmolina518 , i just had a thought for a small UI change , if we could align the headings to match with the smaller font & liked the color scheme used by @jmolina518 , it's looking sleek & smart than bigger headings as of now .

Current editor UI :

Suggested Change

Turkish language ISO code is "TR" not "TUR". Also there are some typo mistakes in Turkish translation.

The Editor component takes a string for a theme. It currently is set to "vs-dark"

• add a dark mode toggle button that toggles the editor theme between "vs-dark" and "vs"

I should be able to re-add a section that I've removed. At the moment, if I add a section, then remove it, there's no way to re-add it.

For instance, I want to see what is in each section. I click on each one in turn, which adds it to the list. I don't want to add it right now, so I delete it. Now I can't find it again.

Currently the text in the section buttons is center aligned when it wraps, it should be left aligned