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

C++ Core Guidelines Markdown to HTML #2196

Closed
Lob2018 opened this issue May 1, 2024 · 1 comment
Closed

C++ Core Guidelines Markdown to HTML #2196

Lob2018 opened this issue May 1, 2024 · 1 comment
Assignees

Comments

@Lob2018
Copy link

Lob2018 commented May 1, 2024

Thanks for your document C++ Core Guidelines.

I have generated a portable HTML version which I find useful (1Mo).

Some points to note:

  • I used VSC with Markdown PDF extension v1.5.0 (yzane)

  • The Markdown changes made are not numerous (on the other hand there are broken links via ???) :

--- C:\Users\toto\Downloads\CppCoreGuidelines.md	Wed May  1 13:20:23 2024
+++ C:\Users\toto\Downloads\CppCoreGuidelines(new).md	Wed May  1 12:45:52 2024
@@ -10,7 +10,7 @@
 This is a living document under continuous improvement.
 Had it been an open-source (code) project, this would have been release 0.8.
 Copying, use, modification, and creation of derivative works from this project is licensed under an MIT-style license.
-Contributing to this project requires agreeing to a Contributor License. See the accompanying [LICENSE](LICENSE) file for details.
+Contributing to this project requires agreeing to a Contributor License. See the accompanying [LICENSE](https://github.com/isocpp/CppCoreGuidelines/blob/master/LICENSE) file for details.
 We make this project available to "friendly users" to use, copy, modify, and derive from, hoping for constructive input.
 
 Comments and suggestions for improvements are most welcome.
@@ -1165,9 +1165,9 @@
 
 See
 
-* [Static analysis tools](???)
+* [Static analysis tools](https://github.com/isocpp/CppCoreGuidelines/tree/master)
 * [Concurrency tools](#Rconc-tools)
-* [Testing tools](???)
+* [Testing tools](https://github.com/isocpp/CppCoreGuidelines/tree/master)
 
 There are many other kinds of tools, such as source code repositories, build tools, etc.,
 but those are beyond the scope of these guidelines.
@@ -3664,7 +3664,7 @@
 ##### Note
 
 Positions can also be transferred by iterators, indices, and references.
-A reference is often a superior alternative to a pointer [if there is no need to use `nullptr`](#Rf-ptr-ref) or [if the object referred to should not change](???).
+A reference is often a superior alternative to a pointer [if there is no need to use `nullptr`](#Rf-ptr-ref) or [if the object referred to should not change](https://github.com/isocpp/CppCoreGuidelines/tree/master).
 
 ##### Note
 
@@ -22644,7 +22644,7 @@
         // ...
     };
 
-This class is a resource handle. It manages the lifetime of the `T`s. To do so, `Vector` must define or delete [the set of special operations](???) (constructors, a destructor, etc.).
+This class is a resource handle. It manages the lifetime of the `T`s. To do so, `Vector` must define or delete [the set of special operations](https://github.com/isocpp/CppCoreGuidelines/tree/master) (constructors, a destructor, etc.).
 
 ##### Example

Suggested Solution

For the links : Use absolute links, and complete broken links in the Markdown's file.

For the Markdown to HTML converters :

  • (VSC extension) Markdown PDF extension v1.5.0 (yzane) - rendering HTML very readable by default ->
    CppCoreGuidelines.zip
  • (VSC extension + local installation) Pandoc
@hsutter
Copy link
Contributor

hsutter commented May 9, 2024

Editors call: Thanks! We'll take a look...

@hsutter hsutter self-assigned this May 9, 2024
@hsutter hsutter closed this as completed in 9656da8 May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants