animade / frontend-md Goto Github PK

I'd love to add this to our internal styleguide, but we use Less instead of SASS.

I see it's on your roadmap, I just thought I'd add an Issue for visibility and so anyone else can voice any opinions or that they would also like this.

The postinstall command chmod u+x app.js fails on Windows as there's no chmod in Win systems.
There might be a way of executing the command only on *nix based systems?

If we could change the presentation of FRONTEND.md file would be excellent!

Hello!

First of all, I absolutely love this tool. So, so useful.

I was wondering whether you'd consider building in support for folder comments? Originally I was thinking you could just have it parse a dotfile in each folder but that would be messy, then I thought it would be easier to just use the package.json?

{
    "frontend": {
    "name": "YOUR PROJECT NAME",
    "stylesheets": "RELATIVE/PATH/TO/STYLESHEETS/FOLDER",
    "javascripts": "RELATIVE/PATH/TO/JAVASCRIPTS/FOLDER",
    "folder_comments": [
            "relative_path_to_folder": "Hello! This is a folder!",
            "assets_scss_vendor_jquery-ui": "jQuery UI styles go here!",
        ]
    }
}

Just an idea! I think it's useful to be able to add comments to certain folders where the developer might be confused about which folder is actually the best place to put a new partial, etc.

Cheers!
Dave

I really liked the simplicity and would want to use it. But my structure is different.

Currently the below entries are Mandatory in package.json.
"frontend": {
"name": "Flux",
"javascripts": "./src",
"stylesheets": "./"
}
But if your structure is different how do you use it.
I would prefer if along with the name the only thing I can enter is "source": "./src" or similar.
This will pick up my complete structure instead of segregating it by JS and CSS
e.g.
"frontend": {
"name": "Flux",
"source": "./src",
}

Hi,

It would be really helpful with some config options for the comments parser.

I'd love to use this for my projects but don't fancy changing my team's commenting style for it to work.

Here's an scss example module, whos comment won't be read. (probably due to the first line being blank)

// *************************************
//
//   Example module
//   -> Overview of module and usage
//
// *************************************

// -------------------------------------
//   Base
// -------------------------------------

.module {

    // -------------------------------------
    //   Variables
    // -------------------------------------

    $module-var:    7em;
    $module-col-fg: #3B5998;
    $module-col-bg: #c0deed;


    // -------------------------------------
    //   Elements
    // -------------------------------------


    // ----- Element description ----- // 

    &__element {}


    // -------------------------------------
    //   Variations
    // -------------------------------------


    // ----- Variation description ----- // 

    &--variation {}

}

Support to read inside scripts and styles folders markdown docs.

We always want to ignore any files that do not want to add in our documentation.

Hi.

I did npm install on a windows server, and chmod does not exist there.

Would it be possible to remove chmod for postinstall, or at least make it cross-platform?

I think will be nicer if use by default the parameter name existing in package.json. Like:

{
  "name": "Webapp",
  "frontend": {
    "stylesheets": "app/styles",
    "javascripts": "app/scripts"
  },
  [...]
}

Thx

Frontend.md doesn't seem to be parsing .sass comments, which start with //.

I noticed you have something going on here but I lack the competence to debug and eventually fix or implement that myself.