chrisant996 / clink

Bash's powerful command line editing in cmd.exe
https://chrisant996.github.io/clink/
GNU General Public License v3.0
3.71k stars 145 forks source link

Unable to build documentation from the source #565

Closed ghost closed 9 months ago

ghost commented 9 months ago

I'm in (HEAD detached at v1.6.3) running premake5 docs get output:

** Warning: `configuration` has been deprecated; use `filter` instead (https://premake.github.io/docs/Filters/)
Running action 'docs'...
Parse tags: clink/app/scripts/cmd.lua
Parse tags: clink/app/scripts/commands.lua
Parse tags: clink/app/scripts/dir.lua
Parse tags: clink/app/scripts/env.lua
Parse tags: clink/app/scripts/exec.lua
Parse tags: clink/app/scripts/prompt.lua
Parse tags: clink/app/scripts/self.lua
Parse tags: clink/app/scripts/set.lua
Parse tags: clink/app/scripts/suggest.lua
Parse tags: clink/app/scripts/update.lua
Parse tags: clink/app/scripts/_manifest.lua
Parse tags: clink/app/src/loader/clink.lua
Parse tags: clink/lua/scripts/arguments.lua
Parse tags: clink/lua/scripts/classifier.lua
Parse tags: clink/lua/scripts/console.lua
Parse tags: clink/lua/scripts/core.lua
Parse tags: clink/lua/scripts/coroutines.lua
Parse tags: clink/lua/scripts/debugger.lua
Parse tags: clink/lua/scripts/error.lua
Parse tags: clink/lua/scripts/events.lua
Parse tags: clink/lua/scripts/generator.lua
Parse tags: clink/lua/scripts/_manifest.lua
Parse tags: clink/lua/scripts/lua_scripts.cpp
Parse tags: clink/lua/src/async_lua_task.cpp
Parse tags: clink/lua/src/clink_api.cpp
Parse tags: clink/lua/src/command_link_dialog.cpp
Parse tags: clink/lua/src/console_api.cpp
Parse tags: clink/lua/src/io_api.cpp
Parse tags: clink/lua/src/line_states_lua.cpp
Parse tags: clink/lua/src/line_state_lua.cpp
Parse tags: clink/lua/src/log_api.cpp
Parse tags: clink/lua/src/lua_editor_tester.cpp
Parse tags: clink/lua/src/lua_exec.cpp
Parse tags: clink/lua/src/lua_input_idle.cpp
Parse tags: clink/lua/src/lua_match_generator.cpp
Parse tags: clink/lua/src/lua_script_loader.cpp
Parse tags: clink/lua/src/lua_state.cpp
Parse tags: clink/lua/src/lua_word_classifications.cpp
Parse tags: clink/lua/src/lua_word_classifier.cpp
Parse tags: clink/lua/src/matches_lua.cpp
Parse tags: clink/lua/src/match_builder_lua.cpp
Parse tags: clink/lua/src/os_api.cpp
Parse tags: clink/lua/src/path_api.cpp
Parse tags: clink/lua/src/pch.cpp
Parse tags: clink/lua/src/prompt.cpp
Parse tags: clink/lua/src/rl_api.cpp
Parse tags: clink/lua/src/rl_buffer_lua.cpp
Parse tags: clink/lua/src/settings_api.cpp
Parse tags: clink/lua/src/string_api.cpp
Parse tags: clink/lua/src/suggest.cpp
Parse tags: clink/lua/src/unicode_api.cpp
Parse tags: clink/lua/src/yield.cpp
Parse tags: clink/lua/test/args.cpp
Parse tags: clink/lua/test/classify.cpp
Parse tags: clink/lua/test/complete.cpp
Parse tags: clink/lua/test/globmatch.cpp
Parse tags: clink/lua/test/io.cpp
Parse tags: clink/lua/test/merge.cpp

>> .build/docs/clink.html
  << docs/clink.html
  << docs/clink.css
  << docs/atom-one-light.css
  << docs/highlight.pack.js
  << docs/clink.md
  << .build/docs/api_html
  << CHANGES
  << CHANGES.older.md
  << docs/credits.md
  << .build/docs/clink_tmp
  << .build/docs/toc_html
Error: C:/Users/Sina/Documents/Lab/CLink/docs/premake5.lua:144: missing name and/or id for heading:
<h1>What is Clink?</h1>

I wanted to go for more investigation but prefer to ask here if someone else had the same issue. Appreciate all the effort. Thanks in advance.

chrisant996 commented 9 months ago

Working fine for me.

chrisant996 commented 9 months ago

Ah, apparently there's been a lot of activity and changes in the marked module -- it's up to 12.0.0 right now. Probably there's a breaking change in the marked module that is generating html differently, and breaking the documentation build script.

Maybe try installing an older version of marked? I'll look into it eventually, but it's very low priority for me.

ghost commented 9 months ago

Currently: premake v5.0.0-beta2 and marked v12.0.0

Maybe try installing an older version of marked? I'll look into it eventually, but it's very low priority for me.

Understandable, I downgrade to marked@2.0.1 everything works fine.