I am using Doxygen 1.8.13 at Linux Debian 9.
I have several readme.md files. Each readme.md file locate at subdirectory (over ~10 projects). I am trying to generate overall documentation for my projects.
Any file readme.md have structure:
//! #page project_name Project name
About project...
For each readme.md, on Related Pages tab, Doxygen generate line "readme" and line with project name. And this list of links looks like this:
readme
readme
readme
readme
Project name one
Project name two
Project name three
Project name four
If click at any "readme" line, i see text: "//!".
The URLs for this "readme"-links is:
..._project_name_one_src_readme.html
..._project_name_four_src_readme.html
Question: how to remove this strange "readme" lines?
Related
I uploaded my android studio project in java on GitHub but it is not showing languages section.
How do I add languages section. And why GitHub failed to detect languages used in repository?
Repository link - https://github.com/QAZIMAAZARSHAD/Bank-Android-App
https://i.stack.imgur.com/6C3il.jpg
These files are considered documentation by Linguist because they're in the app/ folder. You can use the following.
make a file name called .gitattributes this file will override that behavior and paste the following in that file.
app/* linguist-documentation=false
app/* linguist-vendored
I have a built react app in the docs directory of my project. The project is set to have it's github page source to that directory. All that works fine.
https://pgooch.github.io/find-your-ross/#/
As you can see, it all works, notably the image assets, which are located here.
https://github.com/pgooch/find-your-ross/tree/master/docs/static/media
While all of that works absolutely great, the markdown file in that directory 404's.
https://pgooch.github.io/find-your-ross/static/media/_linked_readme.d73385c3.md
The file appears in the repo as you'd expect (it's at the very bottom of the list). I have; waited more than 8 hours, tried different browsers on different devices, and checked that the permissions were good, confirmed that the file names were cased the same. No difference. This file 404s when viewed directly or fetched (as can be seen by clicking about).
The reason why the _linked_readme.d73385c3.md file is not coming up on GitHub pages is due to Jekyll ignoring the file which has a name starting with an underscore.
If you are not using Jekyll, just add an empty .nojekyll file within the docs folder. You can just create the file and commit it on GitHub UI or create the file on your local machine, commit it and push it to the GitHub repo. Once the file is added within the docs folder, the _linked_readme.d73385c3.md file will come up on your GitHub pages site.
Or if you have the option of renaming your file, just drop the underscore at the beginning of the file and rename it from _linked_readme.d73385c3.md to linked_readme.d73385c3.md.
Reference: GitHub
It's not uncommon to have the following structure of projects:
projectA - directory
projectB - directory
projectX - directory
CHANGELOG - file
LICENSE - file
README - file
This structure (the fact that README is located in the root directory) is supported well by different online Git solutions (like github.com, bitbucket.org).
How can we make Eclipse import CHANGELOG, LICENSE, README files from the root of repository and show them in Project Explored/Navigator?
(a similar question was asked Configure github to use some other file as README but its goal was to make online tool render a README from subdirectory. I'm insterested in the opposite: Eclipse showing the README, ...)
For README.md:
Right-click a project and choose New > File
In the New File dialog:
Click Advanced >>
Check Link to file in the file system
Enter PARENT-1-PROJECT_LOC/README.md
Click Finish
Note, these files are shown in the Git Repositories view below the Working Tree node. Instead of using the trick described above, just open these files via the Git Repositories and then edit, save and commit them as usual.
i'm in the process of moving my contributing.md file from the project root to the docs/ directory so it can be with the rest of the documentation. Other markdown files in docs render properly when viewed in github pages. For example, the page
https://jtablesaw.github.io/tablesaw/userguide/toc
renders the page toc.md as expected.
however,
https://jtablesaw.github.io/tablesaw/contributing
returns a 404, while simply adding the .md extension
https://jtablesaw.github.io/tablesaw/contributing.md
returns the page as markdown source
The github project is https://github.com/jtablesaw/tablesaw.
and the contributing.md file is in the docs/ folder.
Zachary's answer is correct but there is a way to modify the jekyll's configuration to include the specific page.
Here is an example: https://masterex.github.io/test-docs/contributing
You have to modify _config.yml as follows:
theme: jekyll-theme-minimal
include: contributing.md
Here is github's relevant help page.
After forking your repo, playing around with it for a bit, and banging my head against the wall because I didn't understand why it wasn't working, I realized something:
Github Pages doesn't support building Jekyll pages from files that have names that Github recognizes for other purposes. These file names include (in addition to their lowercase versions):
CONTRIBUTING.md
ISSUE_TEMPLATE.md
PULL_REQUEST_TEMPLATE.md
ISSUE_AND_PULL_REQUEST_TEMPLATE.md
CODEOWNERS.md
On the other hand, despite that README.md is also a Github keyword file, it looks like Github Pages supports using files with the README.md name because it purposely will interpret them the same way as an index.md or index.html file. See this link from the Github blog for more information.
To answer your specific question on how you could get the file to show at the /tablesaw/contributing path, you could rename it and move it to the /docs/contributing/index.md or /docs/contributing/README.md path.
U̶n̶f̶o̶r̶t̶u̶n̶a̶t̶e̶l̶y̶,̶ ̶a̶t̶ ̶l̶e̶a̶s̶t̶ ̶i̶n̶ ̶t̶h̶e̶ ̶p̶r̶e̶s̶e̶n̶t̶,̶ ̶t̶h̶e̶r̶e̶'̶s̶ ̶c̶u̶r̶r̶e̶n̶t̶l̶y̶ ̶n̶o̶ ̶w̶a̶y̶ ̶t̶o̶ ̶k̶e̶e̶p̶ ̶i̶t̶ ̶w̶i̶t̶h̶ ̶t̶h̶e̶ ̶s̶a̶m̶e̶ ̶f̶i̶l̶e̶ ̶n̶a̶m̶e̶ ̶a̶n̶d̶ ̶h̶a̶v̶e̶ ̶G̶i̶t̶h̶u̶b̶ ̶P̶a̶g̶e̶s̶ ̶b̶u̶i̶l̶d̶ ̶a̶ ̶p̶a̶g̶e̶ ̶f̶o̶r̶ ̶i̶t̶.̶
Edit: #Master_ex notes correctly that you can use the include configuration option in the _config.yml file to include files that would normally be excluded by Github:
theme: jekyll-theme-minimal
include: contributing.md
In reference to the original example, this will allow Github Pages to build a page successfully at the /docs/contributing path.
I'm developing a NuGet package and keep it open source at github.com
My package after installation requires a few configuration steps to be done in VS solution, and I document this in README.md file on github.
I'd like to reference this README.md file in the NuGet package, so that people know what to do after package installation.
I've specified <projectUrl> in my .nuspec file pointing to my Git repo on github.
But it's not obvious for users that they need to click it to read documentation.
I'd like to make it loud and clear for users to follow the link to read full documentation.
It would be nice to have a hyperlink, for example in the <description> field of the .nuspec file, so it's displayed as a hyperlink on the:
project page on nuget.org
package details shown in Visual Studio when browsing \ installing the package
I've tried different ways to add a link, for example XML-escaping < and > as < and > but it doesn't show it as a link, but just as an html text.
The < licenseUrl> and < projectUrl> are the two tags which will show hyperlink in the NuGet package manager. You cannot provide hyperlinks in any other tags. If you want to provide a hyperlink use any of these. Otherwise, you can use a readme file.