cheapreats / auto-readme-docs

https://project-structure-readme.netlify.app/
MIT License
3 stars 0 forks source link

Collapsable Folders #23

Open ralph-dev opened 3 years ago

ralph-dev commented 3 years ago

image

image

Add Collapsable Folders (You need to Keep in Mind the Arrow that will appear that will mess up the Line Indentation :) )

ralph-dev commented 3 years ago

# Automatic Project Structures for README's

<big><pre>
📂 [.github](./.github) # Markdown files that GitHub looks for, like changelogs and issue templates
📂 [public](./public) # Supplemental assets or resources, or static files
📂 [src](./src) # Source files
├── 📂 [components](./src/components) 
│   ├── 📂 [reusable](./src/components/reusable) 
├── 📂 [images](./src/images) 
├── 📂 [tree](./src/tree) 
<details><summary>├──  📂 [utils](./src/utils) </summary>
│   ├── 📂 [createNpmFormatting](./src/utils/createNpmFormatting) 
│   ├── 📂 [deleteFileFromPath](./src/utils/deleteFileFromPath) 
│   ├── 📂 [formatLanguages](./src/utils/formatLanguages) 
│   ├── 📂 [generateMarkDownTree](./src/utils/generateMarkDownTree) 
│   ├── 📂 [getAutoGeneratedCommentForPath](./src/utils/getAutoGeneratedCommentForPath) 
│   ├── 📂 [getCopyToClipboardContents](./src/utils/getCopyToClipboardContents) 
│   ├── 📂 [getFileIconFromFileType](./src/utils/getFileIconFromFileType) 
│   ├── 📂 [getFileTypeFromPath](./src/utils/getFileTypeFromPath) 
│   ├── 📂 [getHyperLinkFromPath](./src/utils/getHyperLinkFromPath) 
│   ├── 📂 [getLargestFileNameLengthInPath](./src/utils/getLargestFileNameLengthInPath) 
│   ├── 📂 [getOwnerAndRepoFromUrl](./src/utils/getOwnerAndRepoFromUrl) 
│   ├── 📂 [repoToBadge](./src/utils/repoToBadge) 
│   ├── 📂 [selectFoldersOnly](./src/utils/selectFoldersOnly) 
│   ├── 📂 [selectRootCores](./src/utils/selectRootCores) 
│   ├── 📂 [setCommentForPath](./src/utils/setCommentForPath) 
│   ├── 📂 [undoDeletions](./src/utils/undoDeletions) 
</details>
</pre></big>

<big><pre>
📂 [.github](./.github) # Markdown files that GitHub looks for, like changelogs and issue templates
📂 [public](./public) # Supplemental assets or resources, or static files
📂 [src](./src) # Source files
├── 📂 [components](./src/components) 
│   ├──   <details><summary>📂 [utils](./src/utils) </summary>📂 [reusable](./src/components/reusable) <details><summary>📂 [utils](./src/utils) </summary>📂 [reusable](./src/components/reusable) </details> </details>

├── 📂 [images](./src/images) 
├── 📂 [tree](./src/tree) 
├── 
<details><summary>📂 [utils](./src/utils) </summary>

│   ├── 📂 [createNpmFormatting](./src/utils/createNpmFormatting) 
│   ├── 📂 [deleteFileFromPath](./src/utils/deleteFileFromPath) 
│   ├── 📂 [formatLanguages](./src/utils/formatLanguages) 
│   ├── 📂 [generateMarkDownTree](./src/utils/generateMarkDownTree) 
│   ├── 📂 [getAutoGeneratedCommentForPath](./src/utils/getAutoGeneratedCommentForPath) 
│   ├── 📂 [getCopyToClipboardContents](./src/utils/getCopyToClipboardContents) 
│   ├── 📂 [getFileIconFromFileType](./src/utils/getFileIconFromFileType) 
│   ├── 📂 [getFileTypeFromPath](./src/utils/getFileTypeFromPath) 
│   ├── 📂 [getHyperLinkFromPath](./src/utils/getHyperLinkFromPath) 
│   ├── 📂 [getLargestFileNameLengthInPath](./src/utils/getLargestFileNameLengthInPath) 
│   ├── 📂 [getOwnerAndRepoFromUrl](./src/utils/getOwnerAndRepoFromUrl) 
│   ├── 📂 [repoToBadge](./src/utils/repoToBadge) 
│   ├── 📂 [selectFoldersOnly](./src/utils/selectFoldersOnly) 
│   ├── 📂 [selectRootCores](./src/utils/selectRootCores) 
│   ├── 📂 [setCommentForPath](./src/utils/setCommentForPath) 
│   ├── 📂 [undoDeletions](./src/utils/undoDeletions) 

</details>

</pre></big>

{{{ - section header
introductory text

{{{ + subsection 1
  subsection 1 test
  possible sub-subsections
}}}
{{{ - subsection 2
  subsection 2 text
}}}
}}}

## Description
A web application that helps automate README creation

## Architecture
Read: https://github.com/MLH-Fellowship/0.2.1-readme-dirs/wiki/Tree-Core-Architecure

## How it Works
Head to [URL](https://project-structure-readme.netlify.app/) and type in your Github Project URL and watch a MarkDown Accessible README with pre-filled descriptions appear!
With a one-click Copy/Paste you can update your README with the best MarkDown Project Structure README's you've ever seen!
```Example Github Project URL: https://github.com/MLH-Fellowship/0.2.1-readme-dirs```

![Project demo](./src/images/Demo.gif)

### WHY
We built this tool two solve two major issues and two minor issues:
#### Major Issues
1) README's don't contain project structures which make it difficult for contributors to understand where everything is and how what's happening inside the repository.
2) Existing Project Structures don't have hyperlinks making the UX of a project structure a bit difficult to navigate with excessive scrolling or third party plugins to extend the functionality. This requires no third-party software and can be done right in Github natively!
#### Minor Issues
1) You can plug in any repo you want to contribute to and completely understand what every folder does thanks to auto generated documentation!
2) You can attach Badges to your repository to help people find the correct NPM Package your repository references!

# Technologies
- [React](https://reactjs.org/) - To Build out the front-end application
- [Github V3 REST API](https://developer.github.com/v3/) - To pull Tree Structures from Github Repositories
- [JavaScript (ES6)](https://www.javascript.com/) - To execute API Requests
- [TypeScript](https://www.typescriptlang.org/)
- [Styled Components (CSS-IN-JS Framework)](http://styled-components.com/)
- [HTML](https://www.w3schools.com/html/html_intro.asp)
- [CSS](https://www.w3schools.com/css/)
- [Babel](https://babeljs.io/)

Source Markdown for examples ^